'1.0',
'info' => ['style' => 'RPC', 'product' => 'Rds', 'version' => '2014-08-15'],
'directories' => [
[
'children' => ['MigrateToOtherZone', 'DescribeAnalyticdbByPrimaryDBInstance', 'DescribeDBInstancesAsCsv'],
'type' => 'directory',
'title' => 'Instance management',
],
[
'children' => ['DescribeUpgradeMajorVersionPrecheckTask', 'DescribeUpgradeMajorVersionTasks', 'UpgradeDBInstanceMajorVersionPrecheck', 'UpgradeDBInstanceMajorVersion'],
'type' => 'directory',
'title' => 'Version upgrade',
],
[
'children' => ['DescribeRdsResourceSettings'],
'type' => 'directory',
'title' => 'Notification',
],
[
'children' => ['GrantAccountPrivilege'],
'type' => 'directory',
'title' => 'Account management',
],
[
'children' => ['DescribeDatabases'],
'type' => 'directory',
'title' => 'Database management',
],
[
'children' => ['CreateReadOnlyDBInstance', 'PrecheckDuckDBDependency'],
'type' => 'directory',
'title' => 'Read-Only Instances',
],
[
'children' => ['UpgradeDBProxyInstanceKernelVersion', 'ModifyDBProxyEndpoint', 'DescribeDBProxy', 'DescribeDBProxyEndpoint', 'DescribeDBProxyPerformance'],
'type' => 'directory',
'title' => 'Dedicated proxy',
],
[
'children' => ['ReleaseReadWriteSplittingConnection'],
'type' => 'directory',
'title' => 'Shared proxy (phased-out)',
],
[
'children' => ['DescribeSecurityGroupConfiguration'],
'type' => 'directory',
'title' => 'Security management',
],
[
'children' => ['DescribeErrorLogs'],
'type' => 'directory',
'title' => 'Log management',
],
[
'children' => ['ModifyBackupSetExpireTime', 'DescribeBackups'],
'type' => 'directory',
'title' => 'Backup and recovery',
],
[
'children' => ['ModifyDBInstanceMonitor'],
'type' => 'directory',
'title' => 'Monitoring management',
],
[
'children' => ['ImportUserBackupFile'],
'type' => 'directory',
'title' => 'Migrate MySQL to the cloud',
],
[
'children' => ['SwitchReplicationLink'],
'type' => 'directory',
'title' => 'disaster recovery instance',
],
[
'children' => ['ModifyComputeBurstConfig', 'DescribeComputeBurstConfig'],
'type' => 'directory',
'title' => 'Assured Serverless',
],
[
'children' => [
'DescribeRCSnapshots', 'DeleteRCSnapshot', 'CreateRCSnapshot', 'DescribeRCDisks', 'AttachRCDisk', 'DescribeRCClusterConfig', 'ModifyDBInstanceReplicationSwitch', 'DescribeDBInstanceReplication', 'MigrateDBNodes', 'SwitchOverMajorVersionUpgrade', 'AssociateEipAddressWithRCInstance', 'StopRCInstance', 'RunRCInstances', 'DescribeRCInstanceAttribute', 'ResizeRCInstanceDisk', 'ModifyRCInstance', 'DescribeRCMetricList', 'DescribeRCInstances', 'DescribeRCImageList', 'CreateRCDisk',
'ReplaceRCInstanceSystemDisk', 'RenewRCInstance', 'AuthorizeRCSecurityGroupPermission', 'AuthorizeBackupEncryption', 'CheckBackupEncryptionAuthorized', 'CheckRegionSupportBackupEncryption', 'DescribeSQLServerUpgradeVersions', 'EnableBackupEncryption', 'CreateMaskingRules', 'ModifyAccountMaskingPrivilege', 'ModifyMaskingRules', 'DescribeMaskingRules', 'DeleteMaskingRules', 'DescribeAccountMaskingPrivilege', 'DeleteParameterTimedScheduleTask', 'DescribeParameterTimedScheduleTask', 'ModifyParameterTimedScheduleTask', 'DescribeDBInstanceCLS', 'ModifyDBInstanceCLS', 'ModifyDBInstanceVectorSupportStatus',
'DescribeImportTaskValidation', 'DescribeImportTask', 'CreateImportTask', 'ValidateImportTask', 'ListImportTasks', 'ModifyImportTask', 'ModifyRCDiskAttribute', 'UpdateDBInstanceReplication', 'CreateDBInstanceReplication', 'DeleteDBInstanceReplication', 'ModifyDBInstance',
],
'type' => 'directory',
'title' => 'Other APIs',
],
[
'children' => ['CreateYouhuiForOrder', 'DescribeCurrentModifyOrder', 'DescribeCustinsResourceInfo', 'DescribeDBInstanceConnectivity', 'DescribeHostGroupElasticStrategyParameters', 'DescribeMarketingActivity', 'DescribeQuickSaleConfig', 'DescribeResourceDetails', 'EvaluateLocalExtendDisk', 'ModifyCustinsResource', 'PreCheckCreateOrderForDeleteDBNodes', 'QueryRecommendByCode'],
'type' => 'directory',
'title' => 'Console Interface',
],
[
'children' => [
'ActivateMigrationTargetInstance', 'AddTagsToResource', 'AllocateInstancePublicConnection', 'AllocateReadWriteSplittingConnection', 'AttachRCInstances', 'AttachWhitelistTemplateToInstance', 'CalculateDBInstanceWeight', 'CancelActiveOperationTasks', 'CheckAccountNameAvailable', 'CheckCloudResourceAuthorized', 'CheckCreateDdrDBInstance', 'CheckDBNameAvailable', 'CheckInstanceExist', 'CheckServiceLinkedRole', 'CloneDBInstance', 'CloneParameterGroup', 'ConfirmNotify', 'CopyDatabase', 'CopyDatabaseBetweenInstances', 'CreateAccount',
'CreateBackup', 'CreateCloudMigrationPrecheckTask', 'CreateCloudMigrationTask', 'CreateDBInstance', 'CreateDBInstanceEndpoint', 'CreateDBInstanceEndpointAddress', 'CreateDBInstanceForRebuild', 'CreateDBInstanceSecurityGroupRule', 'CreateDBNodes', 'CreateDBProxyEndpointAddress', 'CreateDatabase', 'CreateDdrInstance', 'CreateGADInstance', 'CreateGadInstanceMember', 'CreateMigrateTask', 'CreateOnlineDatabaseTask', 'CreateOrderForDeleteDBNodes', 'CreateParameterGroup', 'CreatePostgresExtensions', 'CreateRCImage',
'CreateRCNodePool', 'CreateReplicationLink', 'CreateSecret', 'CreateServiceLinkedRole', 'CreateTempDBInstance', 'DeleteADSetting', 'DeleteAccount', 'DeleteBackup', 'DeleteBackupFile', 'DeleteDBInstance', 'DeleteDBInstanceEndpoint', 'DeleteDBInstanceEndpointAddress', 'DeleteDBInstanceSecurityGroupRule', 'DeleteDBNodes', 'DeleteDBProxyEndpointAddress', 'DeleteDatabase', 'DeleteGadInstance', 'DeleteParameterGroup', 'DeletePostgresExtensions', 'DeleteRCClusterNodes',
'DeleteRCDeploymentSet', 'DeleteRCDisk', 'DeleteRCInstances', 'DeleteReplicationLink', 'DeleteSecret', 'DeleteSlot', 'DeleteUserBackupFile', 'DescibeImportsFromDatabase', 'DescribeADInfo', 'DescribeAccounts', 'DescribeActionEventPolicy', 'DescribeActiveOperationMaintainConf', 'DescribeActiveOperationTasks', 'DescribeAllWhitelistTemplate', 'DescribeAvailableClasses', 'DescribeAvailableCrossRegion', 'DescribeAvailableMetrics', 'DescribeAvailableRecoveryTime', 'DescribeAvailableZones', 'DescribeBackupDatabase',
'DescribeBackupPolicy', 'DescribeBackupTasks', 'DescribeBinlogFiles', 'DescribeCharacterSetName', 'DescribeClassDetails', 'DescribeCloudMigrationPrecheckResult', 'DescribeCloudMigrationResult', 'DescribeCollationTimeZones', 'DescribeCrossBackupMetaList', 'DescribeCrossRegionBackupDBInstance', 'DescribeCrossRegionBackups', 'DescribeCrossRegionLogBackupFiles', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceByTags', 'DescribeDBInstanceDetail', 'DescribeDBInstanceEncryptionKey', 'DescribeDBInstanceEndpoints', 'DescribeDBInstanceHAConfig', 'DescribeDBInstanceIPArrayList', 'DescribeDBInstanceIpHostname',
'DescribeDBInstanceMetrics', 'DescribeDBInstanceMonitor', 'DescribeDBInstanceNetInfo', 'DescribeDBInstanceNetInfoForChannel', 'DescribeDBInstancePerformance', 'DescribeDBInstancePromoteActivity', 'DescribeDBInstanceProxyConfiguration', 'DescribeDBInstanceSSL', 'DescribeDBInstanceSecurityGroupRule', 'DescribeDBInstanceSwitchLog', 'DescribeDBInstanceTDE', 'DescribeDBInstances', 'DescribeDBInstancesByExpireTime', 'DescribeDBInstancesByPerformance', 'DescribeDBInstancesForClone', 'DescribeDBMiniEngineVersions', 'DescribeDTCSecurityIpHostsForSQLServer', 'DescribeDedicatedHostGroups', 'DescribeDedicatedHosts', 'DescribeDetachedBackups',
'DescribeEvents', 'DescribeGadInstances', 'DescribeHADiagnoseConfig', 'DescribeHASwitchConfig', 'DescribeHistoryEvents', 'DescribeHistoryEventsStat', 'DescribeHistoryTasks', 'DescribeHistoryTasksStat', 'DescribeHostWebShell', 'DescribeInstanceAutoRenewalAttribute', 'DescribeInstanceCrossBackupPolicy', 'DescribeInstanceKeywords', 'DescribeInstanceLinkedWhitelistTemplate', 'DescribeKmsAssociateResources', 'DescribeLocalAvailableRecoveryTime', 'DescribeLogBackupFiles', 'DescribeMetaList', 'DescribeMigrateTaskById', 'DescribeMigrateTasks', 'DescribeModifyPGHbaConfigLog',
'DescribeModifyParameterLog', 'DescribeOssDownloads', 'DescribePGHbaConfig', 'DescribeParameterGroup', 'DescribeParameterGroups', 'DescribeParameterTemplates', 'DescribeParameters', 'DescribePostgresExtensions', 'DescribePrice', 'DescribeRCInstanceDdosCount', 'DescribeRCInstanceIpAddress', 'DescribeRCInstanceVncUrl', 'DescribeRCNodePool', 'DescribeReadDBInstanceDelay', 'DescribeRegionInfos', 'DescribeRegions', 'DescribeRenewalPrice', 'DescribeReplicationLinkLogs', 'DescribeResourceUsage', 'DescribeSQLCollectorPolicy',
'DescribeSQLCollectorRetention', 'DescribeSQLLogFiles', 'DescribeSQLLogRecords', 'DescribeSQLLogReportList', 'DescribeSecrets', 'DescribeSlots', 'DescribeSlowLogRecords', 'DescribeSlowLogs', 'DescribeSupportOnlineResizeDisk', 'DescribeTags', 'DescribeTasks', 'DescribeVSwitches', 'DescribeVpcs', 'DescribeWhitelistTemplate', 'DescribeWhitelistTemplateLinkedInstance', 'DestroyDBInstance', 'DetachGadInstanceMember', 'DetachRCDisk', 'DetachWhitelistTemplateToInstance', 'GetDBInstanceTopology',
'GetDbProxyInstanceSsl', 'GrantOperatorPermission', 'ListClasses', 'ListTagResources', 'ListUserBackupFiles', 'LockAccount', 'MigrateConnectionToOtherZone', 'MigrateDBInstance', 'MigrateSecurityIPMode', 'ModifyADInfo', 'ModifyAccountCheckPolicy', 'ModifyAccountDescription', 'ModifyAccountSecurityPolicy', 'ModifyActionEventPolicy', 'ModifyActiveOperationTasks', 'ModifyBackupPolicy', 'ModifyCollationTimeZone', 'ModifyDBDescription', 'ModifyDBInstanceAutoUpgradeMinorVersion', 'ModifyDBInstanceConfig',
'ModifyDBInstanceConnectionString', 'ModifyDBInstanceDelayedReplicationTime', 'ModifyDBInstanceDeletionProtection', 'ModifyDBInstanceDescription', 'ModifyDBInstanceEndpoint', 'ModifyDBInstanceEndpointAddress', 'ModifyDBInstanceHAConfig', 'ModifyDBInstanceMaintainTime', 'ModifyDBInstanceMetrics', 'ModifyDBInstanceNetworkExpireTime', 'ModifyDBInstanceNetworkType', 'ModifyDBInstancePayType', 'ModifyDBInstanceSSL', 'ModifyDBInstanceSecurityGroupRule', 'ModifyDBInstanceSpec', 'ModifyDBInstanceTDE', 'ModifyDBNode', 'ModifyDBProxy', 'ModifyDBProxyEndpointAddress', 'ModifyDBProxyInstance',
'ModifyDTCSecurityIpHostsForSQLServer', 'ModifyDasInstanceConfig', 'ModifyDatabaseConfig', 'ModifyDbProxyInstanceSsl', 'ModifyEventInfo', 'ModifyHADiagnoseConfig', 'ModifyHASwitchConfig', 'ModifyInstanceAutoRenewalAttribute', 'ModifyInstanceCrossBackupPolicy', 'ModifyPGHbaConfig', 'ModifyParameter', 'ModifyParameterGroup', 'ModifyRCDiskSpec', 'ModifyRCInstanceChargeType', 'ModifyRCInstanceDescription', 'ModifyReadWriteSplittingConnection', 'ModifyReadonlyInstanceDelayReplicationTime', 'ModifyResourceGroup', 'ModifySQLCollectorPolicy', 'ModifySQLCollectorRetention',
'ModifySecurityGroupConfiguration', 'ModifySecurityIps', 'ModifyTaskInfo', 'ModifyWhitelistTemplate', 'PurgeDBInstanceLog', 'QueryNotify', 'RebuildDBInstance', 'RebuildReplicationLink', 'ReceiveDBInstance', 'RecoveryDBInstance', 'ReleaseInstanceConnection', 'ReleaseInstancePublicConnection', 'RemoveTagsFromResource', 'RenewInstance', 'ResetAccount', 'ResetAccountPassword', 'RestartDBInstance', 'RestoreDdrTable', 'RestoreTable', 'RevokeAccountPrivilege',
'RevokeOperatorPermission', 'StartDBInstance', 'StartRCInstance', 'StopDBInstance', 'SwitchDBInstanceHA', 'SwitchDBInstanceNetType', 'SwitchDBInstanceVpc', 'TagResources', 'TerminateMigrateTask', 'TransformDBInstancePayType', 'UnlockAccount', 'UntagResources', 'UpdatePostgresExtensions', 'UpdateUserBackupFile', 'UpgradeDBInstanceEngineVersion', 'UpgradeDBInstanceKernelVersion',
],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-9818-CF1DC482C092', 'title' => ''],
'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', 'title' => ''],
'SourcePort' => ['description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', 'title' => ''],
'TaskId' => ['description' => 'The ID of the identification task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440913675', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidMigrateStatus', 'errorMessage' => 'The migrate target instance is not synced with source instance.', 'description' => 'The destination migration instance is not synchronized with the source instance.'],
['errorCode' => 'InvalidMigrateTask', 'errorMessage' => 'No running migrate task found.', 'description' => 'No running migration task found.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-06-07T02:56:13.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-05T05:19:30.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ActivateMigrationTargetInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateMigrationTargetInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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":""}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'The RAM user account does not have the required permissions. Grant the account the required permissions.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
[
['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'Malformed tag key.', 'description' => 'The format of tag key is invalid.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-10-20T08:30:00.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-07-25T01:38:44.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagsToResource'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:AddTagsToResource',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'DbInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp1****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint exist.', 'description' => 'The prefix of the connection address already exists'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'ConnectionStringContainIllegalCharacterFault', 'errorMessage' => 'The connection string contain Illegal character.', 'description' => 'The endpoint contains invalid characters. Modify the endpoint and try again.'],
['errorCode' => 'InvalidInstanceNetworkType', 'errorMessage' => 'The specified InstanceNetworkType is invalid.', 'description' => 'The specified InstanceNetworkType is invalid.'],
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The specified region does not allow you to create a VPC instance.', 'description' => ''],
['errorCode' => 'InvalidInstanceNetworkType.ValueNotSupported', 'errorMessage' => 'The specified parameter "InstanceNetworkType" is not valid.', 'description' => 'The network type failed the verification check. The supported network types are VPC and classic network.'],
['errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', 'description' => ''],
['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is too many.', 'description' => ''],
['errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', 'description' => 'The specified endpoint type is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NetworkConnectionCreating', 'errorMessage' => 'The existing network connection is already being created, please do not create it repeatedly.', 'description' => 'An existing network connection has already been created, please do not create it again.'],
],
403 => [
['errorCode' => 'Invalid.DbInstanceNetType', 'errorMessage' => 'The specified parameter DbInstanceNetType is not valid.', 'description' => 'The network type of the RDS instance is invalid. Set the network type to Internet or Intranet.'],
['errorCode' => 'OperationDenied.SwitchToVPC', 'errorMessage' => 'Specified instance cannot be switched to VPC.', 'description' => 'The network type of the RDS instance cannot be changed to VPC.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-18T06:44:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-27T11:30:07.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-12T15:50:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-02-23T08:49:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-02-23T08:49:40.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:AllocateInstancePublicConnection',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'AllocateReadWriteSplittingConnection' => [
'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-uf6wjk5****', 'title' => ''],
],
[
'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-m5e****-rw.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => '{'."\n"
.' "rm-bp1****": 800,'."\n"
.' "master": 400,'."\n"
.' "slave": 400'."\n"
.'}', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'AllocateReadWriteSplittingConnection',
'summary' => 'Applies for a read-only routing endpoint for an instance.',
'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",
'changeSet' => [
['createdAt' => '2022-06-23T12:09:23.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateReadWriteSplittingConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:AllocateReadWriteSplittingConnection',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C467B38-3910-447D-87BC-AC049166F216\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4C467B38-3910-447D-87BC-AC049166F216\\n","errorExample":""}]',
],
'AssociateEipAddressWithRCInstance' => [
'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', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-i322y2t562oh7o******'."\n", 'docRequired' => true, 'title' => ''],
],
[
'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******', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'AssociateEipAddressWithRCInstance',
'summary' => 'Associates an elastic IP address (EIP) with an RDS Custom instance.',
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateEipAddressWithRCInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:AssociateEipAddressWithRCInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498\\"\\n}","type":"json"}]',
],
'AttachRCDisk' => [
'summary' => 'Invoke the AttachRCDisk API to mount a pay-as-you-go data disk or a system disk to an RDS Custom instance. The instance and the disk must be 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****', 'title' => ''],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['description' => 'The disk ID.', 'type' => 'string', 'required' => true, 'example' => 'rcd-wz98hnpj2sjo85zc7t2w', 'title' => ''],
],
[
'name' => 'DeleteWithInstance',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'List of response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C19D1668-70CB-5421-AA91-D6D8EE3AB664'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => 'The instanceType of the specified instance does not support this disk category.'],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', 'description' => 'Invalid InstanceId, no valid instance data found'],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', 'description' => ''],
['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.', 'description' => '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.', 'description' => 'The instance has expired and the operation is not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', 'description' => ''],
['errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', 'description' => ''],
['errorCode' => 'OperationDenied.InstanceDiskLimitExceeded', 'errorMessage' => 'The amount of the disk on instance in question reach its limits.', 'description' => ''],
['errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', 'description' => 'The current disk does not support this operation.'],
['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', 'description' => ''],
['errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', 'description' => ''],
['errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', 'description' => ''],
['errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
['errorCode' => 'ResourcesNotInSameZone', 'errorMessage' => 'The specified instance and disk are not in the same zone.', 'description' => ''],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C19D1668-70CB-5421-AA91-D6D8EE3AB664\\"\\n}","type":"json"}]',
'title' => 'Mount a data disk or system disk to an RDS Custom instance',
'description' => 'When invoking this API, note the following:'."\n"
.'- The disk status must be Available (ready to mount).'."\n"
.'- When mounting a data disk:'."\n"
.' - The target RDS Custom instance must be in the running or stopped state.'."\n"
.' - If the disk was purchased separately, its metering method must be pay-as-you-go.'."\n"
.' - When a system disk previously detached from an RDS Custom instance is mounted as a data disk, there is no restriction on its metering method.'."\n"
.' - An elastic ephemeral disk, once unmounted, can only be remounted to its original instance.'."\n"
.'- When mounting a system disk:'."\n"
.' - The target RDS Custom instance must be the source instance from which the system disk was originally unmounted.'."\n"
.' - The target RDS Custom instance must be in the stopped state.'."\n"
.' - You must configure logon credentials for the instance.'."\n"
.' - Elastic ephemeral disks cannot be mounted as system disks.',
'changeSet' => [
['createdAt' => '2025-05-07T03:00:44.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachRCDisk'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:AttachRCDisk',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'translator' => 'machine',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The logon password of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''],
],
[
'name' => 'KeyPair',
'in' => 'query',
'schema' => ['description' => 'The key pair of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Custom_test'."\n", 'title' => ''],
],
],
'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', 'title' => ''],
'InstanceId' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'rc-e2g521l55k038cr8****', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '178968983', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AttachRCInstances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachRCInstances'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:AttachRCInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'name' => 'InsName',
'in' => 'query',
'schema' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp191w771kd3****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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*****', 'title' => ''],
],
],
'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',
'title' => '',
],
'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',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.'],
['errorCode' => 'InvalidParameterTemplateId', 'errorMessage' => 'The parameter templateId is invalid.', 'description' => 'The templateId parameter is invalid.'],
['errorCode' => 'InvalidDBInstanceName.TooMuchItems', 'errorMessage' => 'The number of DB instance Names should be no more than 20.', 'description' => 'The number of instance names passed in at a time cannot be greater than 20.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
[
['errorCode' => 'WhitelistTemplateRelationToCustinsId.EXISTS', 'errorMessage' => 'Whitelist Template relation to CustinsId exists.', 'description' => ''],
['errorCode' => 'WhitelistIPLength.Forbidden', 'errorMessage' => 'Whitelist ip length exceeeds the limit.', 'description' => ''],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:16:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-03-15T13:12:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-07T05:52:27.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachWhitelistTemplateToInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:AttachWhitelistTemplateToInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'AuthorizeBackupEncryption' => [
'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](https://help.aliyun.com/document_detail/26243.html) operation to query the latest list of regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'AuthorizationState' => ['description' => 'The authorization state of the account. Valid values:'."\n"
."\n"
.'- 0: unauthorized'."\n"
."\n"
.'- 1: authorized', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'create backup encrypt service linked role error.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1A1DD2A4-69F7-5848-AD56-********', 'title' => ''],
'RoleARN' => ['description' => 'The ARN of the service-linked role for backup encryption.', 'type' => 'string', 'example' => 'acs:ram::113991************:role/AliyunServiceRoleForRdsBackupEncryption', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BackupEncryptUnsupportCallerType', 'errorMessage' => 'backup encrypt caller type not support.', 'description' => 'The account type does not support backup encryption.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Validate backup encryption ',
'summary' => 'Create the AliyunServiceRoleForRdsBackupEncryption service-linked role.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:AuthorizeBackupEncryption',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorizationState\\": 1,\\n \\"Message\\": \\"create backup encrypt service linked role error.\\",\\n \\"RequestId\\": \\"1A1DD2A4-69F7-5848-AD56-********\\",\\n \\"RoleARN\\": \\"acs:ram::113991************:role/AliyunServiceRoleForRdsBackupEncryption\\"\\n}","type":"json"}]',
],
'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, 'title' => ''],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-2ze27hs990o2hn9****', 'docRequired' => true, 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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", 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'docRequired' => true,
'title' => '',
'example' => '',
],
],
[
'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, 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'AuthorizeRCSecurityGroupPermission',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:AuthorizeRCSecurityGroupPermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0688F1D2-CDA8-5617-A43C-ADAC61D80D43\\"\\n}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceType' => ['description' => 'The type of the instance. Valid values:'."\n"
."\n"
.'* **Master**: primary instance'."\n"
.'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', 'title' => ''],
'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', 'title' => ''],
'Weight' => ['description' => 'The read weight that the system calculates in real time for the instance.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', 'description' => 'The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-12T05:45:52.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CalculateDBInstanceWeight',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CalculateDBInstanceWeight'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
],
'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", 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A807C95D-410C-5BB5-96C0-C6E09F2C3D36', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => 'The start time must be later than the current time.'],
['errorCode' => 'IncorrectEventStatus', 'errorMessage' => 'Current event\'s status does not support this operation.', 'description' => 'The current event state does not support this operation.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:CancelActiveOperationTasks',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\\\n\\",\\n \\"RequestId\\": \\"A807C95D-410C-5BB5-96C0-C6E09F2C3D36\\"\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidConnectionInfo', 'errorMessage' => 'Specified ConnectionInfo is not valid.', 'description' => 'The specified ConnectionInfo parameter is invalid.'],
['errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', 'description' => 'Failed to query the account, check the request parameters. For example, check whether the specified account of the RDS for MySQL instance contains special characters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-11-14T06:42:24.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-06-14T07:39:18.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-05T02:21:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckAccountNameAvailable',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckAccountNameAvailable'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CheckBackupEncryptionAuthorized' => [
'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. For example, \'cn-hangzhou\' indicates the China (Hangzhou) region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthorizationState' => ['description' => 'Indicates whether the account is authorized.'."\n"
."\n"
.'- `0`: Unauthorized.'."\n"
."\n"
.'- `1`: Authorized.', 'type' => 'string', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB07C463-7428-50AA-9E39-********', 'title' => ''],
'RoleARN' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the service-linked role that is used for backup encryption.', 'type' => 'string', 'example' => 'acs:ram::1139916************:role/AliyunServiceRoleForRdsBackupEncryption', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query Validation Results for Backup Encryption',
'summary' => 'Check if the AliyunServiceRoleForRdsBackupEncryption service-linked role exists in the user account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckBackupEncryptionAuthorized',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorizationState\\": \\"1\\",\\n \\"RequestId\\": \\"CB07C463-7428-50AA-9E39-********\\",\\n \\"RoleARN\\": \\"acs:ram::1139916************:role/AliyunServiceRoleForRdsBackupEncryption\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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-t4n****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.ByokInsnameAndRegionAllEmpty', 'errorMessage' => 'The insName and targetRegionId can\'t be all empty.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-07-27T13:45:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-07-08T08:25:47.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckCloudResourceAuthorized',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => ''],
['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['errorCode' => 'NoBackupSetRegion', 'errorMessage' => 'BackupSetRegion is absence.', 'description' => 'The backup region does not exist.'],
['errorCode' => 'IncorrectBackupSetType', 'errorMessage' => 'Backup set type should be ddr.', 'description' => 'The type of backup set must be DDR.'],
['errorCode' => 'NoSourceInstanceName', 'errorMessage' => 'No SourceDBInstanceName.', 'description' => 'The source instance name is not found.'],
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', 'description' => 'No available restore set is found.'],
['errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', 'description' => ''],
['errorCode' => 'InvalidBackupType.Format', 'errorMessage' => 'Specified backup type is not valid.', 'description' => 'The operation failed. The backup type is invalid.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectBaksetVersion', 'errorMessage' => 'Current bakset version does not support operations.', 'description' => 'The operation failed. The operation is not supported for the version of the data backup file.'],
['errorCode' => 'CrossRegionUnsupportTDE', 'errorMessage' => 'Cross-region disaster restore not support TDE bakset.', 'description' => ''],
['errorCode' => 'DisasterRestoreRegionNotMatched', 'errorMessage' => 'Disaster restore should be operated in the ddr region or source region.', 'description' => ''],
['errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Specified minor version does not exists.', 'description' => 'The operation failed. The database engine version cannot be found.'],
['errorCode' => 'InvalidDBInstanceId.MalFormed', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => 'The instance ID is invalid. Check the instance ID.'],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'The user ID cannot be found.'],
['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'The operation failed. The UID in the request is left unspecified.'],
['errorCode' => 'UserPermissionFailure', 'errorMessage' => 'The request processing has failed due to user permission.', 'description' => ''],
['errorCode' => 'InvalidServiceType.Format', 'errorMessage' => 'Specified service type is not valid.', 'description' => 'The service type is invalid. Set the service type to 0 or 1. The value 0 indicates an Alibaba Cloud service, and the value 1 indicates a JST service.'],
['errorCode' => 'InvalidStorage.Format', 'errorMessage' => 'Specified Storage is not valid.', 'description' => 'The value of the Storage parameter is invalid. Specify a valid value.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', 'description' => 'RestoreType is not found.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-05-26T06:31:30.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckCreateDdrDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckCreateDdrDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The database name that you want to check.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'Database.QueryError', 'errorMessage' => 'invalid value, may include special character.', 'description' => 'The value is invalid and may contain special characters.'],
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', 'description' => 'Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-05T07:59:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckDBNameAvailable',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDBNameAvailable'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '11439B36-F703-49EB-8656-D3C87BE28B57', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:51.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckInstanceExist'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckInstanceExist',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'CheckRegionSupportBackupEncryption' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceID',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rm-wz91q53f9*******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '081FAAD5-9E56-5BE7-A495-*******', 'title' => ''],
'SupportBackupEncryption' => ['description' => 'Indicates whether backup encryption is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Check whether the instance supports backup encryption ',
'summary' => 'Check if the current region supports backup encryption.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckRegionSupportBackupEncryption',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"081FAAD5-9E56-5BE7-A495-*******\\",\\n \\"SupportBackupEncryption\\": true\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'HasServiceLinkedRole' => ['description' => 'Indicates whether an SLR is created.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequireServiceLinkedRole' => ['description' => 'Indicates whether the service-linked role is required. Default value: true.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AB44DC0A-7E77-442A-97A9-C6418694CB22', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', 'description' => 'The parameter template ID that is specified by the parameterGroupId parameter is invalid. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-01-14T14:02:57.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-27T13:45:29.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CheckServiceLinkedRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CloneDBInstance' => [
'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' => 'A client-generated token that ensures the idempotence of the request. The token must be unique across requests and can be up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => '0c593ea1-3bea-11e9-b96b-88**********', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query the latest regions.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The ID of the primary availability zone. You can call the DescribeRegions operation to query the latest availability zones.'."\n"
."\n"
.'> Defaults to the availability zone of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The instance type of the new instance. For more information, see [Instance types](~~26312~~).'."\n"
."\n"
.'> If you do not specify this parameter, the new instance uses the instance type of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'mysql.n1.micro.1', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The storage capacity of the new instance. Unit: GB. The value must be a multiple of 5. For more information, see [Instance types](~~26312~~).'."\n"
."\n"
.'> If you do not specify this parameter, the new instance uses the storage capacity of the source instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance. The description must be 2 to 255 characters in length. It must start with a letter or a Chinese character, and can contain letters, Chinese characters, digits, underscores (\\_), and hyphens (-).'."\n"
."\n"
.'> The description cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'testInstance', 'title' => ''],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => 'The names of the databases that you want to clone. Format: `Source database 1,Source database 2`.', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
."\n"
.'- **Prepaid**: subscription.'."\n"
."\n"
.'- **Serverless**: This billing method is not supported for MariaDB instances. 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~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'InstanceNetworkType',
'in' => 'query',
'schema' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **VPC**'."\n"
."\n"
.'- **Classic**'."\n"
."\n"
.'> By default, the network type of the new instance is the same as that of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 65535, 'minLength' => 1, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set.'."\n"
."\n"
.'You can call the DescribeBackups operation to query the backup list.'."\n"
."\n"
.'> You must specify at least one of **BackupId** and **RestoreTime**.', 'type' => 'string', 'required' => false, 'example' => '902****', 'title' => ''],
],
[
'name' => 'RestoreTime',
'in' => 'query',
'schema' => ['description' => 'The point in time to which you want to restore data. The point in time must be within the backup retention period. Specify the time 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**.', 'type' => 'string', 'required' => false, 'example' => '2011-06-11T16:00:00Z', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The ID of the vSwitch. The vSwitch must be in the same availability zone as specified by the **ZoneId** parameter.'."\n"
."\n"
.'- The **InstanceNetworkType** parameter must be set to **VPC**.'."\n"
."\n"
.'- If you specify **ZoneSlaveId1**, which specifies the ID of a secondary availability zone, you must specify two vSwitch IDs that are separated by a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
],
[
'name' => 'PrivateIpAddress',
'in' => 'query',
'schema' => ['description' => 'The internal IP address of the new instance. The IP address must be within the CIDR block of the specified vSwitch. The system automatically assigns an IP address based on the **VPCId** and **VSwitchId** parameters.', 'type' => 'string', 'required' => false, 'example' => '172.XX.XX.69', 'title' => ''],
],
[
'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 is **1**, **2**, or **3**.'."\n"
."\n"
.'- If you set the **Period** parameter to **Month**, the value of the UsedTime parameter ranges from **1** to **9**.'."\n"
."\n"
.'> If the **PayType** parameter is set to **Prepaid**, you must specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => 'The unit of the subscription duration. Valid values:'."\n"
."\n"
.'- **Year**'."\n"
."\n"
.'- **Month**'."\n"
."\n"
.'> If the **PayType** parameter is set to **Prepaid**, you must specify this parameter.',
'type' => 'string',
'required' => false,
'enum' => ['Year', 'Month'],
'example' => 'Year',
'title' => '',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The edition of the instance. Valid values:'."\n"
."\n"
.'- **Basic**'."\n"
."\n"
.'- **HighAvailability**'."\n"
."\n"
.'- **AlwaysOn**: Cluster Edition for SQL Server.'."\n"
."\n"
.'- **cluster**: Cluster Edition for MySQL.'."\n"
."\n"
.'- **Finance**: Enterprise Edition. This edition is available only on the China site (aliyun.com).'."\n"
."\n"
.'**Serverless instances**'."\n"
."\n"
.'- **serverless\\_basic**: Serverless Basic Edition. This edition is available only for instances that run MySQL and PostgreSQL.'."\n"
."\n"
.'- **serverless\\_standard**: Serverless Standard Edition for MySQL.'."\n"
."\n"
.'- **serverless\\_ha**: Serverless High-availability Edition for SQL Server.'."\n"
."\n"
.'> You do not need to specify this parameter. The new instance is of the same edition as the source instance.', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'title' => ''],
],
[
'name' => 'ZoneIdSlave1',
'in' => 'query',
'schema' => ['description' => 'The ID of the secondary availability zone. If the value of this parameter is the same as the value of the **ZoneId** parameter, the instance is deployed in a single availability zone. If the value is different, the instance is deployed in multiple availability zones.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', 'title' => ''],
],
[
'name' => 'ZoneIdSlave2',
'in' => 'query',
'schema' => ['description' => ''."\n"
."\n"
.'The ID of the logger availability zone. If the value of this parameter is the same as the value of the **ZoneId** parameter, the instance is deployed in a single availability zone. If the value is different, the instance is deployed in multiple availability zones.'."\n"
."\n"
.''."\n"
."\n"
.''."\n"
."\n"
.'The ID of the secondary or logger availability zone. If the value of this parameter is the same as the value of the **ZoneId** parameter, the instance is deployed in a single availability zone. If the value is different, the instance is deployed in multiple availability zones.'."\n"
."\n"
.'', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The storage type of the instance. Valid values:'."\n"
."\n"
.'- **general\\_essd**: general-purpose enhanced SSD (ESSD). Recommended.'."\n"
."\n"
.'- **local\\_ssd**: local SSD.'."\n"
."\n"
.'- **cloud\\_ssd**: standard SSD.'."\n"
."\n"
.'- **cloud\\_essd**: PL1 ESSD.'."\n"
."\n"
.'- **cloud\\_essd2**: PL2 ESSD.'."\n"
."\n"
.'- **cloud\\_essd3**: PL3 ESSD.'."\n"
."\n"
.'> Serverless instances support only PL1 ESSDs and general-purpose ESSDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'general_essd', 'title' => ''],
],
[
'name' => 'RestoreTable',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to restore data to specific databases and tables. Set this parameter to **1**. If you do not want to restore data to specific databases or tables, do not specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'TableMeta',
'in' => 'query',
'schema' => ['description' => 'The databases and tables that you want to restore. This parameter is required if you set the **RestoreTable** parameter to **1**. The value is a JSON string in the following format:'."\n"
.'`[{"type":"db","name":"Name of database 1","newname":"Name of new database 1","tables":[{"type":"table","name":"Name of table 1 in database 1","newname":"Name of new table 1"},{"type":"table","name":"Name of table 2 in database 1","newname":"Name of new table 2"}]},{"type":"db","name":"Name of database 2","newname":"Name of new database 2","tables":[{"type":"table","name":"Name of table 1 in database 2","newname":"Name of new table 1"},{"type":"table","name":"Name of table 2 in database 2","newname":"Name of new table 2"}]}]`', 'type' => 'string', 'required' => false, 'example' => '[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupId',
'in' => 'query',
'schema' => ['description' => 'The dedicated cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9****', 'title' => ''],
],
[
'name' => 'BackupType',
'in' => 'query',
'schema' => ['description' => 'The backup type. Valid values:'."\n"
."\n"
.'- **FullBackup**: full backup.'."\n"
."\n"
.'- **IncrementalBackup**: incremental backup.', 'type' => 'string', 'required' => false, 'example' => 'FullBackup', 'title' => ''],
],
[
'name' => 'DeletionProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the release protection feature. Valid values:'."\n"
."\n"
.'- **true**: enables the feature.'."\n"
."\n"
.'- **false** (default): disables the feature.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'A parameter that is related to serverless instances. Specify this parameter only when you clone data to a serverless instance.'."\n"
."\n"
.'> This parameter is supported only on the China site (aliyun.com).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['description' => 'This parameter is discontinued. You no longer need to specify this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the Buffer Pool Extension (BPE) feature for a general-purpose ESSD. Valid values:'."\n"
."\n"
.'- **1**: enables the feature.'."\n"
."\n"
.'- **0**: does not enable the feature.'."\n"
."\n"
.'> For more information about BPE, see [Buffer Pool Extension](~~2527067~~).', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'CustomExtraInfo',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the I/O burst feature for a general-purpose ESSD.'."\n"
."\n"
.'- **true**: enables the feature.'."\n"
."\n"
.'- **false**: does not enable the feature.'."\n"
."\n"
.'> For more information about the I/O burst feature, see [What is a general-purpose ESSD?](~~2340501~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the new instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'OrderId' => ['description' => 'The ID of the associated order.', 'type' => 'string', 'example' => '100789370****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidAvZone.NotSupport', 'errorMessage' => 'Specified availableArea multiZone does not support in RDS.', 'description' => ''],
['errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', 'description' => 'The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs.'],
['errorCode' => 'InvalidIPAddress.Conflict', 'errorMessage' => 'IP address conflict.', 'description' => ''],
['errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidRecoveryDbInstance.StorageType', 'errorMessage' => 'The disk local_ssd can not clone to cloud disk type', 'description' => ''],
['errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', 'description' => 'The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance.'],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', 'description' => ''],
['errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of available zones does not match the database engine or instance edition. Please reset it.', 'description' => ''],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'Because the classic network is offline and the service time has expired, you cannot clone an instance of the classic network type.'],
['errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The clone expiration date cannot exceed %s.', 'description' => 'Because the classic network is offline, the usage time of the cloned classic network instance cannot exceed the limit time.'],
['errorCode' => 'MinorVersionTag.NotFound', 'errorMessage' => 'Minor version tags cannot be parsed by the instance.', 'description' => ''],
['errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', 'description' => ''],
['errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', 'description' => 'Xfs instance must be single tenant standard instance.'],
['errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', 'description' => 'The master switch requires at least 3 available IPs.'],
['errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', 'description' => 'The master switch requires at least 2 available IPs.'],
['errorCode' => 'DiskSize.NotEnough', 'errorMessage' => 'The disk size is not enough to restore tables.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', 'description' => 'This operation is not supported for the character type of the instance.'],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', 'description' => 'The metadata information is too large. Check whether the number of instance tables exceeds 50000.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Restore Data (Clone Instance)',
'summary' => 'This API restores historical data to a new cloned instance.',
'description' => '### Applicable engines'."\n"
."\n"
.'- ApsaraDB RDS for MySQL'."\n"
."\n"
.'- ApsaraDB RDS for PostgreSQL'."\n"
."\n"
.'- ApsaraDB RDS for SQL Server'."\n"
."\n"
.'- ApsaraDB RDS for MariaDB'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before using this operation, read the related documentation to fully understand its prerequisites and impact.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Restore data for an ApsaraDB RDS for MySQL instance](~~96147~~)'."\n"
."\n"
.'- [Restore data for an ApsaraDB RDS for PostgreSQL instance](~~96776~~)'."\n"
."\n"
.'- [Restore data for an ApsaraDB RDS for SQL Server instance](~~95722~~)'."\n"
."\n"
.'- [Restore data for an ApsaraDB RDS for MariaDB instance](~~97151~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-28T09:13:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-30T03:25:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-26T15:39:02.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-20T06:08:27.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-25T13:12:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-06-07T02:56:13.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-10T04:16:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-04T11:54:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-21T06:07:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-17T08:58:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-25T01:38:44.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-01T16:23:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-12-02T02:45:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-26T03:32:25.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-23T03:59:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-02-10T09:50:46.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CloneDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": \\"100789370****\\",\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2****\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', 'description' => 'The parameter template ID that is specified by the parameterGroupId parameter is invalid. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.'],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', 'description' => 'The parameter does not exist. Check parameter configurations.'],
['errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', 'description' => 'The parameter type is invalid.'],
['errorCode' => 'ParamGroupOptionValue.NotSupport', 'errorMessage' => 'Specified option value unsupported.', 'description' => ''],
['errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', 'description' => 'The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.'],
['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'One or more of the request parameters provided are not valid.', 'description' => 'One or more of the request parameters provided are not valid, please check the API document'],
['errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'ParamGroupOptionKey.NotFound', 'errorMessage' => 'Specified system parameter group option unregistered.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-04-18T13:35:57.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-09T03:04:00.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-05-09T13:07:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneParameterGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CloneParameterGroup',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
'example' => '',
],
],
],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidNotifyId', 'errorMessage' => 'No auth to confirm record', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:ConfirmNotify',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNotify'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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-wz9s06u4drm******'."\n", 'title' => ''],
],
[
'name' => 'SrcDBName',
'in' => 'query',
'schema' => ['description' => 'The source database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db1***', 'title' => ''],
],
[
'name' => 'DstDBName',
'in' => 'query',
'schema' => ['description' => 'The destination database name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db2***', 'title' => ''],
],
[
'name' => 'ReserveAccount',
'in' => 'query',
'schema' => ['description' => 'The reserved account.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test02', 'title' => ''],
'DBStatus' => ['description' => 'The status of the database. Valid values:'."\n"
."\n"
.'* **Creating**'."\n"
.'* **Running**'."\n"
.'* **Deleting**'."\n", 'type' => 'string', 'example' => ' Creating', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '2562****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', 'description' => 'Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified account name is not valid.', 'description' => 'The specified account name is invalid.'],
['errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.'],
['errorCode' => 'InvalidCharacterSetName.Format', 'errorMessage' => 'Specified character set name is not valid.', 'description' => 'The character set is invalid. ApsaraDB RDS supports the following character sets: gbk, utf8, euckr, and ascii.'],
['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', 'description' => 'Your account does not have the required permissions.'],
['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => 'The password of the account is invalid. Specify a valid password.'],
['errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', 'description' => 'The database description is invalid. Specify a valid description.'],
['errorCode' => 'InvalidReserveAccount.Format', 'errorMessage' => 'Specified ReserveAccount is not valid.', 'description' => ''],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'DBLimitExceeded', 'errorMessage' => 'DBQuotaExceeded: Exceeding the allowed amount of DB.', 'description' => 'The number of databases in the RDS instance reaches the upper limit. Delete unused databases from the RDS instance.'],
['errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account', 'description' => 'The number of accounts exceeds the maximum number of accounts that are allowed.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', 'description' => 'The operation failed. The account mode of the current instance does not support this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', 'description' => 'The operation failed. The instance name cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-09-10T07:50:27.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-07-21T09:58:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyDatabase'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CopyDatabase',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'description' => 'This operation is phased out.'."\n",
],
'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-bp172446ys9cf****', 'title' => ''],
],
[
'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-bp1m71wvzfiq7****', 'title' => ''],
],
[
'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' => '{"zhttest":"zhttest"}', 'title' => ''],
],
[
'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' => '259321****', 'title' => ''],
],
[
'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' => '2025-06-08T17:41:14Z', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'InvalidBackupSetID', 'errorMessage' => 'Invalid backup set id.', 'description' => 'The backup set does not exist. You can call the DescribeBackups operation to query existing backup sets.'],
['errorCode' => 'DBCountLimitExceeded', 'errorMessage' => 'Db count limit exceeded.', 'description' => 'The number of databases is exceeded.'],
['errorCode' => 'BackupRestoreNotSupported.BasicHA', 'errorMessage' => 'Basic instances cannot be restored to high availability instances, and high availability instances cannot be restored to basic instances.', 'description' => 'You cannot restore data from an RDS instance in the Basic Edition to an RDS instance in the High-availability Edition and vice versa.'],
['errorCode' => 'BackupRestoreNotSupported.HADedicatedAlwaysOn', 'errorMessage' => 'High availability instances cannot be restored to dedicated cluster instances or AlwaysOn instances.', 'description' => 'The operation failed. The data of an RDS instance that runs the RDS High-availability Edition cannot be restored to an RDS instance that is deployed in a dedicated cluster or runs the RDS Enterprise Edition.'],
['errorCode' => 'BackupRestoreNotSupported.ShareDedicatedAlwaysOn', 'errorMessage' => 'Shared instances cannot be restored to dedicated cluster instances, AlwaysOn instances, or high availability instances.', 'description' => ''],
['errorCode' => 'OperationDenied.RestoreTime', 'errorMessage' => 'The instance with snapshot backup enabled can only be restored to the instance with snapshot backup enabled.', 'description' => 'You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup.'],
['errorCode' => 'OperationDenied.SnapshotBackupSet', 'errorMessage' => 'Snapshot backup set can only be restored to the instance with snapshot backup enabled.', 'description' => 'You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup and whose backup set type is snapshot.'],
['errorCode' => 'CanNotCopyDBHasTDEEnabled', 'errorMessage' => 'The source database has enabled the TDE feature. You cannot copy it to another instance.', 'description' => 'TDE is enabled for the source RDS instance. Therefore, the data of the source RDS instance cannot be replicated to a different RDS instance.'],
['errorCode' => 'InvalidBackupDBNames.NotFound', 'errorMessage' => 'The specified BackupDBNames is not found.', 'description' => ''],
['errorCode' => 'InvalidBackupDBNames.Malformed', 'errorMessage' => 'The specified backup database is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => ''],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'InvalidTargetDBInstanceName.Format', 'errorMessage' => 'Specified Target DB instance name is not valid.', 'description' => ''],
['errorCode' => 'MasterDBInstanceState.NotSupport', 'errorMessage' => 'The Master instance state does not support this operation.', 'description' => ''],
['errorCode' => 'TargetInstanceEngineNotSupported', 'errorMessage' => 'The specified Engine cannot be supported the operation.', 'description' => ''],
['errorCode' => 'InvalidInstancesRegion.Malformed', 'errorMessage' => 'The instance region is not the same as the target instance region.', 'description' => ''],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'The specified parameter "StartTime" is not valid.', 'description' => 'The start time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. For example, you can set the start time to 2012-06-11T15:00Z in the DescribeDBInstancePerformance operation and set the start time to 2011-06-11T16:00Z in the DescribeErrorLogs operation.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'The specified parameter "EndTime" is not valid.', 'description' => 'The operation failed. The end time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', 'description' => ''],
['errorCode' => 'InvalidCrossRegionTrans', 'errorMessage' => 'Cross region instance trans is not supported', 'description' => ''],
['errorCode' => 'ErrorParametersConflict', 'errorMessage' => 'Parameter BackupsetID and restoretime can only exist one.', 'description' => ''],
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified DB name does not exist.', 'description' => 'The database name cannot be found. Enter a valid database name.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => ''],
['errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', 'description' => 'The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance.'],
['errorCode' => 'InvalidRecoveryDBNames.Format', 'errorMessage' => 'The specified parameter DBNames is not valid.', 'description' => 'The instance name is invalid. Check the instance name.'],
['errorCode' => 'InvalidBackupIdOrRestoreTime.NotFound', 'errorMessage' => 'The specified parameter BackupId or RestoreTime is not valid.', 'description' => 'The operation failed. The values of the BackupId and RestoreTime parameters are invalid.'],
['errorCode' => 'Forbidden.RegionNotFound', 'errorMessage' => 'The provided RegionId does not exist in our record.', 'description' => 'The operation failed. The region ID cannot be found.'],
['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', 'description' => ''],
['errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', 'description' => ''],
['errorCode' => 'InvalidEngineOrEngineVersion', 'errorMessage' => 'The specified params engine or engineVersion should not be null.', 'description' => ''],
['errorCode' => 'InvalidGeneralGroupNameOrGdnInstanceName', 'errorMessage' => 'The specified params generalGroupName or gdnInstanceName should not be null.', 'description' => ''],
['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', 'description' => 'No vSwitch is available in the VPC.'],
['errorCode' => 'CDDC.TargetHostIDNotAvailable', 'errorMessage' => 'The target host ID is not available.', 'description' => 'The host is unavailable. Specify a different host.'],
['errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', 'description' => ''],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', 'description' => 'Read-only instances do not support the operation.'],
['errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType is not support operation.', 'description' => 'This operation is not supported for the specified instance type.'],
['errorCode' => 'InvalidQuantity.NotSupported', 'errorMessage' => 'The specified instance quantity is not supported.', 'description' => 'The number of RDS instances exceeds the upper limit. Check the number of RDS instances.'],
['errorCode' => 'IncorrectMasterDBInstanceState', 'errorMessage' => 'Master instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.ReadDBInstanceExceeded', 'errorMessage' => 'Current DB Instance exceeding the allowed amount of read instance.', 'description' => ''],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'The cloud ESSD storage size is invalid.', 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['errorCode' => 'IncorrectInstanceNetworkType', 'errorMessage' => 'The specified parameter InstanceNetworkType is not valid.', 'description' => ''],
['errorCode' => 'AtLeastTwoVSwitchParamExists', 'errorMessage' => 'The specified params(Vswitchs) at least two.', 'description' => 'At least two Vswitchs parameters must be specified. Each Vswitchs parameter specifies a vSwitch in a zone.'],
['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', 'description' => 'The VPC cannot be found in the zone. Specify a different VPC and try again.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'Specified database does not exists in the backup set.', 'description' => ''],
['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.', 'description' => '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.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
],
403 => [
['errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance.', 'description' => ''],
['errorCode' => 'InvalidTempInstance.NotSupport', 'errorMessage' => 'The temp db Instance is not support.', 'description' => 'The instance is locked.'],
['errorCode' => 'InvalidTargetDBInstanceName.Format', 'errorMessage' => 'Specified Target DB instance name is not valid.', 'description' => 'The name of the destination instance is invalid.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database instance state does not support the operation.', 'description' => 'The operation failed. The RDS instance is not running.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'Forbidden.SnapshotRecovery', 'errorMessage' => 'Snapshot backup does not support partial restore', 'description' => 'The operation failed. Snapshot backup files cannot be used to restore only a specific part of data.'],
['errorCode' => 'OperationDenied.Resource', 'errorMessage' => 'Specified DB instance class or storage is not available in all Availability Zones.', 'description' => 'Insufficient resources. Try again with a different instance type or storage size.'],
['errorCode' => 'ReadonlyDBInstanceStorageExceeded', 'errorMessage' => 'You can not create the order with the db instance because The masterInstance storage value exceeding the readonlyInstance storage value.', 'description' => 'The primary instance storage value exceeds the read-only instance storage value. You cannot use the database instance to create an order.'],
['errorCode' => 'MasterDBInstanceClassNotSupport', 'errorMessage' => 'You can not create the readonly instance with the master instance class does not support.', 'description' => 'The operation failed. The current primary instance class does not support creating read-only instances.'],
['errorCode' => 'ReadonlyDBInstanceClassNotSupport', 'errorMessage' => 'You can not create the readonly instance with the instance class does not support.', 'description' => 'The operation failed. The current instance class does not support creating read-only instances.'],
['errorCode' => 'ReadonlyDBInstanceClassLowerThanMasterInstance', 'errorMessage' => 'The readonly instance db instance class are lower than master instance db instance class.', 'description' => 'The read-only instance has lower specifications than the primary instance.'],
['errorCode' => 'InvalidSwitchType.Malformed', 'errorMessage' => 'The specified parameter InvalidSwitchType is not valid.', 'description' => 'The value of the InvalidSwitchType parameter is invalid.'],
['errorCode' => 'UnsupportedCopyDbHighAvailabilityToBasic', 'errorMessage' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Basic is not supported.', 'description' => ''],
['errorCode' => 'InvalidInstanceVersion', 'errorMessage' => 'Source instance version is greater than the target instance version.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbShareToHighAvailability', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:HighAvailability is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbAlwaysOnToBasic', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Basic is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbBasicToShare', 'errorMessage' => 'Replicate Database from RDS Category:Basic to RDS Category:Share is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbAlwaysOnToHighAvailability', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:HighAvailability is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbShareToBasic', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:Basic is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbHighAvailabilityToShare', 'errorMessage' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Share is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbShareToAlwaysOn', 'errorMessage' => 'Replicate Database from RDS Category:Share to RDS Category:AlwaysOn is not supported.', 'description' => ''],
['errorCode' => 'UnsupportedCopyDbAlwaysOnToShare', 'errorMessage' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Share is not supported.', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta.RestoreTime', 'errorMessage' => 'The specified restore time cannot be covered by the existing backup chain. Please try specifying a different restore time.', 'description' => ''],
['errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', 'description' => 'The current recovery model does not support.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance.', 'description' => 'The disk usage exceeds the upper limit. Free your disk space.'],
['errorCode' => 'InvalidInstanceStorageType.NotFound', 'errorMessage' => 'The specified DBInstanceStorageType is not found.', 'description' => 'You must specify the InstanceStorageType parameter.'],
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', 'description' => 'The region ID is invalid.'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', 'description' => 'Current cluster resources are insufficient. Try again later.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid params to call rds open api, BakDBNames is not empty.', 'description' => 'The BakDBNames parameter that is used to call the ApsaraDB RDS API is invalid. You must specify a value for the parameter.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-29T01:46:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-16T02:09:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-02T02:33:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-06T02:17:26.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-12-19T05:20:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-07-19T09:02:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-28T07:01:12.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyDatabaseBetweenInstances'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CopyDatabaseBetweenInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"803D11AF-C370-465B-AB46-CB3A642DC303\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 803D11AF-C370-465B-AB46-CB3A642DC303\\n","errorExample":""}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testuser', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', 'description' => 'A switchover for high availability is in progress. Please wait.'],
['errorCode' => 'InvalidEngineVersion.NotSupported', 'errorMessage' => 'Current db instance does not support sysadmin.', 'description' => 'The operation failed. The current instance does not support creating sysAdmin accounts.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'Account.AddError', 'errorMessage' => 'Create Account failed, please check your input value or may your input value not satisfy instance current policy', 'description' => 'Failed to create the account. Check the specified parameters or the parameter policy configuration.'],
['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => 'The password of the account is invalid. Specify a valid password.'],
['errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified account description is not valid.', 'description' => 'The account description is invalid. Specify a valid description. The description can be up to 256 characters in length and cannot be left unspecified.'],
['errorCode' => 'InvalidGeneralGroupNameOrGdnInstanceName', 'errorMessage' => 'The specified params generalGroupName or gdnInstanceName should not be null.', 'description' => ''],
['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', 'description' => 'Your account does not have the required permissions.'],
['errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.'],
['errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', 'description' => 'The database description is invalid. Specify a valid description.'],
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'InvalidAccountType.Format', 'errorMessage' => 'The first account can\'t be normal type.', 'description' => 'The first account can\'t be normal type.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', 'description' => 'Failed to query the account, check the request parameters. For example, check whether the specified account of the RDS for MySQL instance contains special characters.'],
['errorCode' => 'InvalidConnectionInfo', 'errorMessage' => 'Specified ConnectionInfo is not valid.', 'description' => 'The specified ConnectionInfo parameter is invalid.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
['errorCode' => 'InstanceAccountSameWithOsAccount', 'errorMessage' => 'The instance account name cannot be the same as the OS account name.', 'description' => 'The user instance account name cannot be the same as the host account name.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'GlobalReadonlyAccountMaxCountExceed', 'errorMessage' => 'The number of global read-only accounts exceeds the limit.', 'description' => 'The number of global read-only accounts exceeds the upper limit.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'AccountQuotaExceeded: Exceeding the allowed amount of account', 'description' => 'The number of accounts exceeds the maximum number of accounts that are allowed.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-05-20T09:16:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-28T09:13:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-09T13:00:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-07-26T11:28:57.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateAccount',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateBackup' => [
'summary' => 'Create a backup set for an RDS 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 obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The names of the databases that you want to back up. Separate multiple database names with commas (,).'."\n"
."\n"
.'> This parameter applies only when the **BackupStrategy** parameter is set to **db**.', 'type' => 'string', 'required' => false, 'example' => 'rds_mysql', 'title' => ''],
],
[
'name' => 'BackupStrategy',
'in' => 'query',
'schema' => ['description' => 'The backup strategy. Valid values:'."\n"
."\n"
.'- **db**: database backup'."\n"
."\n"
.'- **instance**: instance backup'."\n"
."\n"
.'> This parameter applies only in the following cases:'."\n"
.'>'."\n"
.'> - For a MySQL instance, this parameter applies when the **BackupMethod** parameter is set to **Logical**.'."\n"
.'>'."\n"
.'> - For a SQL Server instance, this parameter applies when the **BackupType** parameter is set to **FullBackup**.', 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''],
],
[
'name' => 'BackupMethod',
'in' => 'query',
'schema' => ['description' => 'The backup method. Valid values:'."\n"
."\n"
.'- **Logical**: logical backup. This method is applicable only to MySQL instances that use local disks.'."\n"
."\n"
.'- **Physical**: physical backup. This method is applicable to MySQL instances that use local disks, and to SQL Server and PostgreSQL instances.'."\n"
."\n"
.'- **Snapshot**: snapshot backup. This method is applicable to MySQL instances that use cloud disks, and to SQL Server, PostgreSQL, and MariaDB instances.'."\n"
."\n"
.'Default value: **Physical**.'."\n"
."\n"
.'> - For logical backups, the database cannot be empty.'."\n"
.'>'."\n"
.'> - MariaDB instances support only snapshot backups. However, you must set this parameter to **Physical**.', 'type' => 'string', 'required' => false, 'example' => 'Physical', 'title' => ''],
],
[
'name' => 'BackupType',
'in' => 'query',
'schema' => ['description' => 'The backup type for a SQL Server instance. Valid values:'."\n"
."\n"
.'- **Auto** (default): The system automatically selects between a full backup and an incremental backup.'."\n"
."\n"
.'- **FullBackup**: full backup'."\n"
."\n"
.'> This parameter takes effect only when **BackupMethod** is set to **Physical**.', 'type' => 'string', 'required' => false, 'example' => 'Auto', 'title' => ''],
],
[
'name' => 'BackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => '- For **SQL Server** instances, you can specify the retention period for a backup set if **BackupStrategy** is set to **db**, **BackupMethod** is set to **Physical**, and **BackupType** is set to **FullBackup**. The value must be an integer from 7 to 730. A value of -1 specifies long-term retention.'."\n"
."\n"
.'- **MySQL**: The retention period for backup sets can be 7 to 730 days, or -1 for long-term retention.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Contains the response parameters.',
'type' => 'object',
'properties' => [
'BackupJobId' => ['description' => 'The backup job ID.', 'type' => 'string', 'example' => '507****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2C125605-266F-41CA-8AC5-3A643D4F42C5', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BackupType.NotSupport', 'errorMessage' => 'the specified backup type not support', 'description' => 'This operation is not supported for the specified backup type.'],
['errorCode' => 'InvalidBackupMethod.ValueNotSupport', 'errorMessage' => 'The specified parameter "BackupMethod" is not valid.', 'description' => 'The backup method is invalid. Specify a valid backup method. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for RDS instances in which no databases are created, and physical backups are supported only for RDS instances that run SQL Server.'],
['errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'BackupJobExists', 'errorMessage' => 'A backup job already exists in the specified DB instance.', 'description' => 'The backup has been created.'],
['errorCode' => 'InvalidPreferredBackupTime.Format', 'errorMessage' => 'Specified preferred backup time is not valid.', 'description' => 'The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.ApiForbidden', 'errorMessage' => 'operation not permitted.', 'description' => 'The operation is not allowed.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'Exceeded.BackupTimes', 'errorMessage' => 'The backup times exceeds.', 'description' => 'The specified BackupTimes parameter is invalid.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support this operation.', 'description' => 'The operation failed. The database cannot be found or is not in a ready state. You can call the DescribeDatabases operation to view the databases of an RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupJobId\\": \\"507****\\",\\n \\"RequestId\\": \\"2C125605-266F-41CA-8AC5-3A643D4F42C5\\"\\n}","type":"json"}]',
'title' => 'Create a Backup Set for an RDS Instance ',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'- RDS SQL Server'."\n"
."\n"
.'- RDS MariaDB'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This API calls the native RDS backup API. You can also use DBS. For more information, see [DBS API Overview](~~2841997~~)see [DBS API Overview](~~2402073~~).'."\n"
."\n"
.'### Usage notes'."\n"
."\n"
.'The API call succeeds only if the instance meets the following conditions:'."\n"
."\n"
.'- The instance is running.'."\n"
."\n"
.'- No backup tasks are in progress.'."\n"
."\n"
.'- A maximum of 20 backup sets can be created per instance per day.'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'- [Back up an RDS MySQL instance](~~378074~~)'."\n"
."\n"
.'- [Back up an RDS PostgreSQL instance](~~96772~~)'."\n"
."\n"
.'- [Back up an RDS SQL Server instance](~~95717~~)'."\n"
."\n"
.'- [Back up an RDS MariaDB instance](~~97147~~)',
'requestParamsDescription' => '#### Optional parameters'."\n"
."\n"
.'This API has four optional parameters: `BackupMethod`, `BackupStrategy`, `BackupType`, and `DBName`. Use specific parameter combinations depending on the database engine and your backup scenario.'."\n"
."\n"
.'### MySQL'."\n"
."\n"
.'- For a physical backup or snapshot backup, specify only the `BackupMethod` parameter. By default, all databases are backed up. Single-database backups are not supported.'."\n"
."\n"
.'- For a logical backup:'."\n"
."\n"
.' - For a single-database backup, specify the `BackupMethod`, `BackupStrategy`, and `DBName` parameters.'."\n"
."\n"
.' - To back up an entire instance, specify the `BackupMethod` and `BackupStrategy` parameters.'."\n"
."\n"
.'### SQL Server'."\n"
."\n"
.'- For a snapshot backup, specify only the `BackupMethod` parameter. By default, all databases are backed up. Single-database backups are not supported.'."\n"
."\n"
.'- For a physical backup:'."\n"
."\n"
.' - For a single-database full backup, specify all four optional parameters.'."\n"
."\n"
.' - For an entire instance full backup, specify the `BackupMethod`, `BackupType`, and `BackupStrategy` parameters.'."\n"
."\n"
.' - For a system-determined incremental or full backup, specify the `BackupMethod` and `BackupType` parameters.'."\n"
."\n"
.'- Logical backups are not supported.'."\n"
."\n"
.'### PostgreSQL'."\n"
."\n"
.'- For a physical backup or snapshot backup, specify only the `BackupMethod` parameter. By default, all databases are backed up. Single-database backups are not supported.'."\n"
."\n"
.'- Logical backups are not supported.'."\n"
."\n"
.'### MariaDB'."\n"
."\n"
.'- For a snapshot backup, specify only the `BackupMethod` parameter. By default, all databases are backed up. Single-database backups are not supported.'."\n"
."\n"
.'- Physical and logical backups are not supported.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-06T13:01:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-14T03:34:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-14T03:34:29.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateBackup',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '439946016', 'title' => ''],
'TaskName' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'slf7w7wj3g', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-05-22T06:50:31.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateCloudMigrationPrecheckTask',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudMigrationPrecheckTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'aliyunRDS', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440437220', 'title' => ''],
'TaskName' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateCloudMigrationTask',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudMigrationTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CreateDBInstance' => [
'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 [DescribeRegions](~~610399~~) to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database engine. Valid values:'."\n"
.'* **MySQL**'."\n"
.'* **SQLServer**'."\n"
.'* **PostgreSQL**'."\n"
.'* **MariaDB**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version. Valid values:'."\n"
.'* Regular instances'."\n"
.' * MySQL: **5.5**, **5.6**, **5.7**, **8.0**'."\n"
.' * SQL Server: **08r2_ent_ha** (cloud disk, discontinued), **2008r2** (Premium Local SSDs, discontinued), **2012** (Enterprise Edition 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**, **2022_web**'."\n"
.' * PostgreSQL: **10.0**, **11.0**, **12.0**, **13.0**, **14.0**, **15.0**, **16.0**, **17.0**, **18.0**'."\n"
.' * MariaDB: **10.3**, **10.6**'."\n"
.'* Serverless instances'."\n"
.' * MySQL: **5.7**, **8.0**'."\n"
.' * SQL Server: **2016\\_std\\_sl**, **2017\\_std\\_sl**, **2019\\_std\\_sl**'."\n"
.' * PostgreSQL: **14.0**, **15.0**, **16.0**, **17.0**, **18.0**'."\n"
."\n"
.'> - MariaDB does not support Serverless instances.'."\n"
.'> - For SQL Server instances, `_ent` indicates Enterprise Cluster Edition, `_ent_ha` indicates Enterprise Edition, `_std_ha` indicates Standard Edition, and `_web` indicates Web Edition.'."\n"
.'> - SQL Server 2014 instances are not available on the China site (Chinese mainland).'."\n"
.'> - Babelfish for RDS PostgreSQL instances support only major version 15.0.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8.0', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The instance type. You can specify a standard or YiTian instance type. For details, see [Primary instance types](~~26312~~).'."\n"
."\n"
.'To create a Serverless instance, set this parameter to one of the following values:'."\n"
."\n"
.'- MySQL Basic Edition: **mysql.n2.serverless.1c**'."\n"
.'- MySQL High-availability Edition: **mysql.n2.serverless.2c**'."\n"
.'- SQL Server: **mssql.mem2.serverless.s2**'."\n"
.'- PostgreSQL Basic Edition: **pg.n2.serverless.1c**'."\n"
.'- PostgreSQL High-availability Edition: **pg.n2.serverless.2c**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql.n2.medium.2c', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The instance storage capacity. Unit: GB. The value must be in increments of 5 GB. For the value range, see [Primary instance types](~~26312~~).', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''],
],
[
'name' => 'SystemDBCharset',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to configure this parameter.', 'type' => 'string', 'required' => false, 'example' => 'gbk', 'title' => ''],
],
[
'name' => 'DBInstanceNetType',
'in' => 'query',
'schema' => [
'description' => 'The network connectivity type of the instance. Set the value to **Intranet**, which specifies an internal network connection.',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Intranet',
'title' => '',
],
],
[
'name' => 'DBInstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The name of the instance. The name must be 2 to 255 characters in length and can contain letters, digits, Chinese characters, and hyphens (-). It must start with a letter or a Chinese character.'."\n"
.'> The name cannot start with http:// or https://.', 'type' => 'string', 'required' => false, 'example' => 'testInstance', 'title' => ''],
],
[
'name' => 'SecurityIPList',
'in' => 'query',
'schema' => ['description' => 'The [IP address whitelist](~~43185~~) of the instance. Separate multiple entries with commas (,). Each entry must be unique. A maximum of 1,000 IP addresses or CIDR blocks can be added for a single instance. The following two formats are supported:'."\n"
.'* IP address format, such as 10.10.XX.XX.'."\n"
.'* CIDR format, such as 10.10.XX.XX/24 (classless inter-domain routing, where 24 indicates the length of the prefix, ranging from 1 to 32).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.10.XX.XX/24', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
.'- **Prepaid**: subscription.'."\n"
.'- **Serverless**: Serverless billing. This value is not supported for MariaDB instances. For more information, see [Introduction to MySQL Serverless instances](~~411291~~), [Introduction to SQL Server Serverless instances](~~604344~~), and [Introduction to PostgreSQL Serverless instances](~~607742~~).'."\n"
.'> The system automatically generates an order and completes the payment. You do not need to manually confirm the payment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the primary node.'."\n"
."\n"
.'- If you specify a VPC and a vSwitch, you must specify the zone ID of the vSwitch. Otherwise, the instance cannot be created.'."\n"
.'- For High-availability Edition instances, you must also specify **ZoneIdSlave1** to determine whether the instance uses single-zone or multi-zone deployment.'."\n"
.'- For RDS Enterprise Edition instances, you must also specify **ZoneIdSlave1** and **ZoneIdSlave2** to determine whether the instance uses single-zone or multi-zone deployment.'."\n"
.'- For RDS Cluster Edition instances, you must also specify **ZoneIdSlave1** for two-node clusters, and **ZoneIdSlave1** and **ZoneIdSlave2** for three-node clusters.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''],
],
[
'name' => 'ZoneIdSlave1',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the secondary node.'."\n"
."\n"
.'- If you set this parameter to **Auto**, the system automatically selects a zone for the secondary node in a multi-zone deployment.'."\n"
.'- If this parameter is set to the same value as **ZoneId**, the instance uses single-zone deployment.'."\n"
.'- If this parameter is set to a value different from **ZoneId**, the instance uses multi-zone deployment.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', 'title' => ''],
],
[
'name' => 'ZoneIdSlave2',
'in' => 'query',
'schema' => ['description' => 'RDS MySQL Cluster Edition instances support creating one or two secondary nodes when you create an instance. You can use this parameter to specify the zone ID of the second secondary node.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', 'title' => ''],
],
[
'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"
.'> * MySQL cloud disk instances support only VPCs. You must set this parameter to **VPC**.'."\n"
.'> * PostgreSQL and MariaDB instances support only VPCs. You must set this parameter to **VPC**.'."\n"
.'> * SQL Server Basic Edition and Web Edition instances support both classic networks and VPCs. All other SQL Server instances support only VPCs. You must set this parameter to **VPC**.', 'type' => 'string', 'default' => 'VPC', 'required' => false, 'example' => 'VPC', 'title' => ''],
],
[
'name' => 'ConnectionMode',
'in' => 'query',
'schema' => ['description' => 'The access mode of the instance. Valid values:'."\n"
.'* **Standard**: standard access mode.'."\n"
.'* **Safe**: database proxy mode.'."\n"
."\n"
.'Default value: allocated by the RDS system.'."\n"
.'> SQL Server 2012, 2016, and 2017 support only the standard access mode.', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.'."\n"
.'> This parameter takes effect only when the network type **InstanceNetworkType** is set to **VPC**.', 'type' => 'string', 'required' => false, 'example' => 'vpc-****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.'."\n"
."\n"
.'- **Zone mapping**: The zone of the vSwitch must match the primary node zone (ZoneId) and the secondary node zone (ZoneIdSlave1). If you specify two vSwitch IDs, their order must correspond to the order of ZoneId and ZoneSlaveId1.'."\n"
.'- **Network type restriction**: **InstanceNetworkType** must be set to **VPC**.'."\n"
.'- **Multiple vSwitch requirement**: If you specify **ZoneSlaveId1** (secondary node zone ID) and the value is not **Auto**, you must specify two vSwitch IDs separated by a comma (,).'."\n"
.'- **Character restriction**: The vSwitch ID cannot contain special characters such as `spaces`, `!`, `#`, `¥`, `&`, or `%`.', 'type' => 'string', 'required' => false, 'example' => 'vsw-****', 'title' => ''],
],
[
'name' => 'PrivateIpAddress',
'in' => 'query',
'schema' => ['description' => 'Sets the internal IP address of the instance. The IP address must be within the address range of the specified vSwitch. By default, the system automatically allocates an internal IP address based on the values of **VPCId** and **vSwitchId**.', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', 'title' => ''],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => [
'description' => 'The subscription duration. Valid values:'."\n"
.'* If **Period** is set to **Year**, **UsedTime** can be set to **1 to 5**.'."\n"
.'* If **Period** is set to **Month**, **UsedTime** can be set to **1 to 11**.'."\n"
."\n"
.'> This parameter is required if **PayType** is set to **Prepaid**.',
'type' => 'string',
'required' => false,
'pattern' => '^\\d+$',
'enum' => [],
'example' => '2',
'title' => '',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => 'The unit of the subscription duration. Valid values:'."\n"
.'* **Year**'."\n"
.'* **Month**'."\n"
."\n"
.'> This parameter is required if **PayType** is set to **Prepaid**.',
'enumValueTitles' => [],
'type' => 'string',
'enum' => ['Year', 'Month', 'Day', '1', '2', '3'],
'required' => false,
'example' => 'Year',
'title' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The instance storage type. Valid values:'."\n"
.'* **local_ssd**: Premium Local SSDs (recommended).'."\n"
.'* **general_essd**: premium performance disk (recommended).'."\n"
.'* **cloud_essd**: PL1 ESSD.'."\n"
.'* **cloud_essd2**: PL2 ESSD.'."\n"
.'* **cloud_essd3**: PL3 ESSD.'."\n"
.'* **cloud_ssd**: standard SSD (not recommended because standard SSDs are no longer available for purchase in some regions).'."\n"
."\n"
.'The default value of this parameter is determined by the instance type specified in **DBInstanceClass**:'."\n"
.'* If the instance type is for Premium Local SSDs, the default value is **local_ssd**.'."\n"
.'* If the instance type is for cloud disks, the default value is **cloud_essd**.'."\n"
."\n"
.'> Serverless instances support only PL1 ESSDs and premium performance disks.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'general_essd', 'title' => ''],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['description' => 'The business extension parameter.', 'type' => 'string', 'required' => false, 'example' => '121436975448952', 'title' => ''],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the cloud disk encryption key in the same region. If you specify this parameter, cloud disk encryption is enabled and cannot be disabled. You must also specify **RoleARN**.'."\n"
."\n"
.'You can view the key ID in the Key Management Service (KMS) console or create a key. For more information, see [Create a key](~~181610~~).'."\n"
."\n"
.'> - For ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, and ApsaraDB RDS for SQL Server, you do not need to specify this parameter. You only need to specify **RoleARN** to create a cloud disk-encrypted instance by using a service key.'."\n"
.'> - RAM authorization is supported to require RAM users to enable cloud disk encryption when creating instances. If cloud disk encryption is not enabled, instance creation is denied. The RAM authorization configuration is as follows:'."\n"
.'`{"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}`'."\n"
.'>This configuration also affects the CreateOrder operation for creating instances in the console.>', 'type' => 'string', 'required' => false, 'example' => '0d24*****-da7b-4786-b981-9a164dxxxxxx', 'title' => ''],
],
[
'name' => 'RoleARN',
'in' => 'query',
'schema' => ['description' => 'The global resource descriptor (ARN) that is used for the authorization of the Alibaba Cloud account to allow the RDS cloud service account to access KMS. You can call the CheckCloudResourceAuthorized operation to query the ARN.'."\n"
.'>You must specify **RoleARN** when you enable cloud disk encryption.>', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole', 'title' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. This parameter is valid only for subscription instances. Valid values:'."\n"
.'- **true**'."\n"
.'- **false**'."\n"
."\n"
.'> - If you purchase the instance on a monthly basis, the auto-renewal cycle is one month.'."\n"
.'> - If you purchase the instance on a yearly basis, the auto-renewal cycle is one year.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The instance edition. Valid values:'."\n"
.'* Regular instances'."\n"
.' * **Basic**: Basic Edition.'."\n"
.' * **HighAvailability**: High-availability Edition.'."\n"
.' * **cluster**: MySQL or PostgreSQL Cluster Edition.'."\n"
.' * **AlwaysOn**: SQL Server Cluster Edition.'."\n"
.' * **Finance**: RDS Enterprise Edition.'."\n"
.' > This parameter is required when you create an SQL Server Enterprise Cluster Edition instance, a Basic Edition Standard instance, or a Basic Edition Enterprise instance. For example, to create a Basic Edition 2022 Enterprise Cluster Edition (2022_ent) instance, you must set this parameter to Basic.'."\n"
.'* Serverless instances'."\n"
.' * **serverless_basic**: Serverless Basic Edition. (Applicable to MySQL and PostgreSQL only)'."\n"
.' * **serverless_standard**: Serverless High-availability Edition. (Applicable to MySQL and PostgreSQL only)'."\n"
.' * **serverless_ha**: SQL Server Serverless High-availability Edition.'."\n"
."\n"
.' > This parameter is required when PayType is set to Serverless.', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the dedicated cluster host group.'."\n"
."\n"
.'This parameter is required when you create an ApsaraDB RDS instance in a dedicated cluster.'."\n"
."\n"
.'- You can call the DescribeDedicatedHostGroups operation to query the host group information.'."\n"
.'- If you have not created a host group, you can call the CreateDedicatedHostGroup operation to create one.', 'type' => 'string', 'required' => false, 'example' => 'dhg-4n****', 'title' => ''],
],
[
'name' => 'TargetDedicatedHostIdForMaster',
'in' => 'query',
'schema' => ['description' => 'The host ID of the primary instance in the dedicated cluster.'."\n"
."\n"
.'This parameter is required when you create an ApsaraDB RDS instance in a dedicated cluster. 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 information in the dedicated cluster.'."\n"
.'- If you do not have a host, you can call the CreateDedicatedHost operation to add one.', 'type' => 'string', 'required' => false, 'example' => 'i-bp****', 'title' => ''],
],
[
'name' => 'TargetDedicatedHostIdForSlave',
'in' => 'query',
'schema' => ['description' => 'The host ID of the secondary instance in the dedicated cluster.'."\n"
."\n"
.'This parameter is required when you create an ApsaraDB RDS High-availability Edition or RDS Enterprise Edition instance in a dedicated cluster. If you do not specify this parameter, the system automatically allocates a host by default.'."\n"
."\n"
.'- You can call the DescribeDedicatedHosts operation to query the host information in the dedicated cluster.'."\n"
.'- If you do not have a host, you can call the CreateDedicatedHost operation to add one.', 'type' => 'string', 'required' => false, 'example' => 'i-bp****', 'title' => ''],
],
[
'name' => 'TargetDedicatedHostIdForLog',
'in' => 'query',
'schema' => ['description' => 'The host ID of the log instance in the dedicated cluster.'."\n"
."\n"
.'This parameter is required when you create an ApsaraDB RDS Enterprise Edition instance in a dedicated cluster. 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 information in the dedicated cluster.'."\n"
.'- If you do not have a host, you can call the CreateDedicatedHost operation to add one.', 'type' => 'string', 'required' => false, 'example' => 'i-bp****', 'title' => ''],
],
[
'name' => 'DBParamGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the parameter template. You can call the DescribeParameterGroups operation to query parameter templates.'."\n"
.'> This parameter is supported only for MySQL and PostgreSQL. If you do not specify this parameter, the default system parameter template is used. You can also create a custom parameter template and specify it here.', 'type' => 'string', 'required' => false, 'example' => 'rpg-sys-****', 'title' => ''],
],
[
'name' => 'DBTimeZone',
'in' => 'query',
'schema' => ['description' => 'The time zone of the instance. This parameter takes effect only when **Engine** is set to **MySQL** or **PostgreSQL**.'."\n"
."\n"
.'- If **Engine** is set to **MySQL**:'."\n"
.' - This parameter specifies the UTC time zone. Valid values: **-12:59** to **+13:00**.'."\n"
.' - Instances with Premium Local SSDs can use named time zones, such as Asia/Hong_Kong. For more information, see [Named time zone reference](~~297356~~).'."\n"
.'- If **Engine** is set to **PostgreSQL**:'."\n"
.' - This parameter specifies a named time zone. UTC time zones are not supported. For more information, see [Named time zone reference](~~297356~~).'."\n"
.' - This parameter is configurable only for PostgreSQL instances with cloud disks.'."\n"
."\n"
.'> - You can set the time zone when you create a primary instance. Read-only instances do not support time zone settings and inherit the time zone of the primary instance.'."\n"
.'> - If you do not specify this parameter, the system selects the default time zone based on the region of the instance.', 'type' => 'string', 'required' => false, 'example' => '+08:00', 'title' => ''],
],
[
'name' => 'DBIsIgnoreCase',
'in' => 'query',
'schema' => ['description' => 'Specifies whether table names are case-sensitive. Valid values:'."\n"
.'* **true**: Table names are case-insensitive (default).'."\n"
.'* **false**: Table names are case-sensitive.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TargetMinorVersion',
'in' => 'query',
'schema' => ['description' => 'The minor engine version of the ApsaraDB RDS instance. This parameter is required only when you create a MySQL or PostgreSQL instance.'."\n"
.'Format:'."\n"
.'* MySQL: `_`. Examples: `rds_20200229`, `xcluster_20200229`, or `xcluster80_20200229`. Description:'."\n"
.' * rds: High-availability Edition or Basic Edition.'."\n"
.' * xcluster: MySQL 5.7 RDS Enterprise Edition.'."\n"
.' * xcluster80: MySQL 8.0 RDS Enterprise Edition.'."\n"
."\n"
.' > You can call the DescribeDBMiniEngineVersions operation to query the numeric version number. For information about version differences, see [AliSQL minor version release notes](~~96060~~).'."\n"
.'* PostgreSQL: `rds_postgres_00_`. Example: `rds_postgres_1400_20220830`. Description:'."\n"
.' * 1400: The PostgreSQL major version is 14.'."\n"
.' * 20220830: The AliPG minor kernel version. You can call the DescribeDBMiniEngineVersions operation to query the version. For information about version differences, see [PostgreSQL minor version release notes](~~126002~~).'."\n"
."\n"
.' > If Babelfish is enabled in **BabelfishConfig**, the minor engine version format for the ApsaraDB RDS for PostgreSQL instance is: `rds_postgres_00__babelfish`.', 'type' => 'string', 'required' => false, 'example' => 'rds_20200229', 'title' => ''],
],
[
'name' => 'StorageAutoScale',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable automatic storage expansion. This parameter is supported only for MySQL and PostgreSQL. Valid values:'."\n"
.'* **Enable**'."\n"
.'* **Disable** (default)'."\n"
."\n"
.'> You can also call the ModifyDasInstanceConfig operation to adjust this setting after the instance is created. For more information, see [Configure automatic storage expansion](~~173826~~).',
'enumValueTitles' => [],
'type' => 'string',
'enum' => ['Enable', 'Disable'],
'required' => false,
'example' => 'Disable',
'title' => '',
],
],
[
'name' => 'StorageThreshold',
'in' => 'query',
'schema' => [
'description' => 'The threshold (in percentage) that triggers automatic storage expansion. Valid values:'."\n"
.'* **10**'."\n"
.'* **20**'."\n"
.'* **30**'."\n"
.'* **40**'."\n"
.'* **50**'."\n"
."\n"
.'> This parameter is required when **StorageAutoScale** is set to **Enable**.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'enum' => ['10', '20', '30', '40', '50'],
'required' => false,
'example' => '50',
'title' => '',
],
],
[
'name' => 'StorageUpperBound',
'in' => 'query',
'schema' => ['description' => 'The maximum storage capacity for automatic storage expansion. Automatic expansion does not cause the total storage capacity of the instance to exceed this value. Unit: GB.'."\n"
."\n"
.'> - The value must be greater than or equal to 0.'."\n"
.'> - This parameter is required when **StorageAutoScale** is set to **Enable**.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2000', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run for the instance creation. Valid values:'."\n"
.'* **true**: performs a dry run without creating the instance. The system checks items such as the request parameters, request format, business limits, and available resources.'."\n"
.'* **false**: sends the request and creates the instance after the request passes the check (default).', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'UserBackupId',
'in' => 'query',
'schema' => ['description' => 'The user backup ID. You can call the ListUserBackupFiles operation to query user backups. If you specify this parameter, the instance is created from the specified user backup.'."\n"
."\n"
.'The following restrictions apply:'."\n"
.'- **PayType** must be set to **Postpaid**.'."\n"
.'- **Engine** must be set to **MySQL**.'."\n"
.'- **EngineVersion** must be set to **5.7**.'."\n"
.'- **Category** must be set to **Basic**.', 'type' => 'string', 'required' => false, 'example' => '67798****', 'title' => ''],
],
[
'name' => 'Amount',
'in' => 'query',
'schema' => ['description' => 'The number of ApsaraDB RDS for MySQL instances to create. This parameter is applicable only to batch creation of ApsaraDB RDS for MySQL instances.'."\n"
."\n"
.'Valid values: **1** to **20**. Default value: **1**.'."\n"
."\n"
.'> - When you create multiple ApsaraDB RDS for MySQL instances, you can use the **Tag.Key** and **Tag.Value** parameters to tag instances in the same batch for easier management.'."\n"
.'> - After multiple ApsaraDB RDS for MySQL instances are created, only the **TaskId**, **RequestId**, and **Message** parameters are returned. To query the details of individual instances, call the DescribeDBInstanceAttribute operation.'."\n"
.'> - If **Engine** is not set to **MySQL** and the value of this parameter is greater than **1**, the operation fails and the error code `InvalidParam.Engine` is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'CreateStrategy',
'in' => 'query',
'schema' => ['description' => 'The strategy for batch instance creation. This parameter takes effect only when the **Amount** parameter is greater than 1. Valid values:'."\n"
.'* **Atomicity** (default): atomic. All instances in the same batch must be created successfully. If one instance fails to be created, all instances fail.'."\n"
.'* **Partial**: non-atomic. The creation of each instance is independent of other instances in the same batch.', 'type' => 'string', 'required' => false, 'example' => 'Atomicity', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The details of the tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. Specify this parameter to bind a tag to the instance.'."\n"
."\n"
.'* If the specified tag key already exists, the tag key is directly bound to the instance. You can call the ListTagResources operation to query existing tags.'."\n"
.'* If the specified tag key does not exist, the tag key is created and then bound to the instance.'."\n"
.'* Empty strings are not allowed.'."\n"
.'* This parameter must be used together with **Tag.Value**.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''],
'Value' => ['description' => 'The tag value that corresponds to the tag key. Specify this parameter to bind a tag to the instance.'."\n"
."\n"
.'* If the specified tag value already exists for the corresponding tag key, the tag value is directly bound to the instance. You can call the ListTagResources operation to query existing tags.'."\n"
.'* If the specified tag value does not exist for the corresponding tag key, the tag value is created and then bound to the instance.'."\n"
.'* This parameter must be used together with **Tag.Key**.', 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'DeletionProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the release protection feature. This parameter is supported only for pay-as-you-go instances. Valid values:'."\n"
.'* **true**'."\n"
.'* **false** (default)', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'BabelfishConfig',
'in' => 'query',
'schema' => ['description' => 'The Babelfish for RDS PostgreSQL configuration.'."\n"
."\n"
.'Configuration format: {"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}'."\n"
."\n"
.'Parameter description:'."\n"
.'- **babelfishEnabled**: specifies whether to enable Babelfish. Set the value to **true** to enable Babelfish. If this parameter is not specified, Babelfish is not enabled by default.'."\n"
.'- **migrationMode**: the database mode. Set the value to **single-db** for single-database mode or **multi-db** for multi-database mode.'."\n"
.'- **masterUsername**: the initial administrator account name. The name 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. The password must be 8 to 32 characters in length. Valid special characters include `! @ # $ % ^ & * () _ + - =`.'."\n"
."\n"
.'> This parameter is applicable only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for RDS PostgreSQL, see [Introduction to Babelfish](~~428613~~).', 'type' => 'string', 'required' => false, 'example' => '{"babelfishEnabled":"true","migrationMode":"single-db","masterUsername":"babelfish_user","masterUserPassword":"Babelfish123!"}', 'title' => ''],
],
[
'name' => 'ServerlessConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The settings for the Serverless instance. This parameter is required when you create a Serverless instance.'."\n"
.'> MariaDB does not support Serverless instances.',
'type' => 'object',
'properties' => [
'MaxCapacity' => ['description' => 'The maximum number of RDS Capacity Units (RCUs) for automatic scaling. Valid values:'."\n"
."\n"
.'- MySQL: **1 to 32**'."\n"
.'- SQL Server: **2 to 16**'."\n"
.'- PostgreSQL: **1 to 14**'."\n"
."\n"
.'> The value must be greater than or equal to **MinCapacity** and must be an **integer**.', 'type' => 'number', 'format' => 'double', 'default' => '8.0', 'required' => false, 'example' => '8', 'title' => ''],
'MinCapacity' => ['description' => 'The minimum number of RCUs for automatic scaling. Valid values:'."\n"
."\n"
.'- MySQL: **0.5 to 32**'."\n"
.'- SQL Server: **2 to 16** (integers only)'."\n"
.'- PostgreSQL: **0.5 to 14**'."\n"
."\n"
.'> The value must be less than or equal to **MaxCapacity**.', 'type' => 'number', 'format' => 'double', 'default' => '0.5', 'required' => false, 'example' => '0.5', 'title' => ''],
'AutoPause' => ['description' => 'Specifies whether to enable the smart suspension and startup feature for the Serverless instance. Valid values:'."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n"
."\n"
.'> This parameter is required only for MySQL and PostgreSQL Serverless instances. If no connections are established within 10 minutes, the instance is suspended. The instance is automatically resumed when a connection is established.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
'SwitchForce' => ['description' => 'Specifies whether to enable forced scaling for the Serverless instance. Valid values:'."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n"
."\n"
.'> * This parameter is required only for MySQL and PostgreSQL Serverless instances. After this parameter is enabled, the instance may be unavailable for 30 to 120 seconds during forced scaling. Use this feature with caution.'."\n"
.'> * RCU scaling typically takes effect immediately. However, in certain scenarios (such as during large transaction execution), scaling cannot be completed immediately. In this case, you can enable this parameter to force scaling.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => 'The internal endpoint of the database.'."\n"
."\n"
.'Endpoint format: `xxx.mysql.rds.aliyuncs.com`, where `xxx` is the prefix of the instance ID, such as rm-uf6wjk5***.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => 'The port number for the ApsaraDB RDS instance. Valid values:'."\n"
.'- MySQL: 1000 to 65534'."\n"
.'- PostgreSQL, SQL Server, and MariaDB: 1000 to 5999', 'type' => 'string', 'required' => false, 'example' => '3306', 'title' => ''],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the I/O burst feature for the premium performance disk. Valid values:'."\n"
.'* **true**: enabled.'."\n"
.'* **false**: disabled.'."\n"
.'> For more information about the I/O burst feature for the premium performance disk, see [What is premium performance disk](~~2340501~~).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n"
."\n"
.'- **true**: Automatic payment is enabled. Make sure that your account balance is sufficient.'."\n"
.'- **false**: Only an order is generated. No payment is made.'."\n"
."\n\n"
."\n\n"
.'> The default value is true. If your payment method has an insufficient balance, set AutoPay to false. In this case, an unpaid order is generated. You can log on to the ApsaraDB RDS console to complete the payment.'."\n"
.'>', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [Buffer Pool Extension (BPE)](~~2527067~~) feature for the premium performance cloud disk. Valid values:'."\n"
."\n"
.' - **1**: enabled.'."\n"
.' - **0**: disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'ColdDataEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [cold data archiving](~~2701832~~) feature for the premium performance disk. Valid values:'."\n"
."\n"
.'- **true**: enabled.'."\n"
.'- **false**: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'WhitelistTemplateList',
'in' => 'query',
'schema' => ['description' => 'The IP address whitelist.'."\n"
.'To specify multiple IP addresses or CIDR blocks, separate them with commas (,). No spaces are allowed before or after the commas. Example: `192.168.0.1,172.16.213.9`.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1,172.16.213.9', 'title' => ''],
],
[
'name' => 'AutoCreateProxy',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically create a database proxy. Valid values:'."\n"
."\n"
.'- **true**: Automatic creation is enabled. A general-purpose database proxy is created by default.'."\n"
."\n"
.'- **false**: Automatic creation is disabled.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use coupons. Valid values:'."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n"
."\n"
.'> If you use a coupon and later perform a specification downgrade, the amount deducted by the coupon is not refunded.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', 'title' => ''],
],
[
'name' => 'OptimizedWrites',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable the [16KB atomic write](~~2858761~~) feature. Valid values:'."\n"
."\n"
.'- **optimized**: enabled.'."\n"
.'- **none** (default): disabled.',
'type' => 'string',
'enum' => ['optimized', 'none'],
'required' => false,
'example' => 'optimized',
'title' => '',
],
],
[
'name' => 'ExternalReplication',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable [RDS MySQL native replication](~~2856526~~). Valid values:'."\n"
.'- **ON**: enabled.'."\n"
.'- **OFF**: disabled.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'ON', 'title' => ''],
],
[
'name' => 'CustomExtraInfo',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DryRunResult' => ['description' => 'Indicates whether the dry run for instance creation passed. Valid values:'."\n"
.'* **true**: passed.'."\n"
.'* **false**: failed.'."\n"
."\n"
.'> * This parameter is not returned if no dry run is performed.'."\n"
.'> * If the dry run fails, the corresponding error is returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TagResult' => ['description' => 'Indicates whether the tags were successfully bound to the instance. Valid values:'."\n"
.'* **true**: succeeded.'."\n"
.'* **false**: failed.'."\n"
."\n"
.'> This parameter is not returned if no tags are bound to the instance.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
'ConnectionString' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
'Message' => ['description' => 'The message for the batch creation task.'."\n"
."\n"
.'> This parameter is returned only when the **Amount** parameter is greater than 1.', 'type' => 'string', 'example' => 'Batch Create DBInstance Task Is In Process.', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID. If the **Amount** parameter is set to a value greater than **1**, the corresponding number of instance IDs are returned, separated by commas (,).'."\n"
."\n"
.'For example, if **Amount** is set to **3**, three instance IDs are returned. Example:'."\n"
.'`rm-uf6wjk5*****1,rm-uf6wjk5*****2,rm-uf6wjk5*****3`', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'Port' => ['description' => 'The port number of the internal endpoint of the instance.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'TaskId' => ['description' => 'The task ID for the batch creation task.'."\n"
."\n"
.'* This parameter is returned only when the **Amount** parameter is greater than 1.'."\n"
.'* Querying tasks by **TaskId** is not currently supported.', 'type' => 'string', 'example' => 's2365879-a9d0-55af-fgae-f2****', 'title' => ''],
'DryRun' => ['description' => 'Indicates that a dry run is performed before instance creation.'."\n"
."\n"
.'* The return value is always **true**.'."\n"
.'* This parameter is not returned if no dry run is performed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '1007893702****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid.ParamGroupDBVersion', 'errorMessage' => '%s.%s', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage 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.', 'description' => 'A security risk was detected in the default payment method. Please verify your payment method before placing your order. A verification link will be sent to you via email and internal message.'],
['errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.'],
['errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', 'description' => 'The specified region is closed or invalid for the specified DBInstanceStorageType.'],
['errorCode' => 'InvalidNetworkTypeClassicWhenCloudStorage', 'errorMessage' => 'The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.', 'description' => 'When selecting a cloud storage type, specifying a InstanceNetworkType value of Classic is not valid.'],
['errorCode' => 'InvalidZone.NotSupported', 'errorMessage' => 'The Specified Zone not supported.', 'description' => 'The zone is invalid.'],
['errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Some Reuquest Parameters Is Invalid. Check or Try It Again Later.', 'description' => ''],
['errorCode' => 'Pay.AmountLimitExceeded', 'errorMessage' => 'Pay amount limit exceeded.', 'description' => ''],
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'Pay.LowFunds', 'errorMessage' => 'The balance of the advance payment is insufficient or there is no balance of the advance payment.', 'description' => ''],
['errorCode' => 'Pay.ChargeChannelNotFound', 'errorMessage' => 'Failure to obtain the first external payment channel if the advance balance is insufficient.', 'description' => ''],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', 'description' => 'The operation failed. No vSwitch IP addresses are available.'],
['errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', 'description' => 'The IP address has been used.'],
['errorCode' => 'InvalidEcsImage.NotFound', 'errorMessage' => 'Sepcified ecs image does not exist', 'description' => ''],
['errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Sepcified minor version does not exists.', 'description' => ''],
['errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'Concurrent operation is detected.', 'description' => 'Concurrent operations exist. Wait until the previous operation is complete and try again.'],
['errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of ZoneId specified does not match with category.', 'description' => 'The number of zones is not supported for the database engine or the RDS edition of the RDS instance. Modify the zone settings.'],
['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'The specified parameter securityIPList is not valid.', 'description' => 'The format of the IP address whitelist does not meet the requirements. Check the IP address whitelist.'],
['errorCode' => 'InvalidDBParamGroupId.Format', 'errorMessage' => 'The specified parameter dbParamGroupId is not valid.', 'description' => ''],
['errorCode' => 'InvalidTargetMinorVersion.Format', 'errorMessage' => 'The specified parameter targetMinorVersion is not valid.', 'description' => ''],
['errorCode' => 'InvalidDedicatedHostGroupId.Format', 'errorMessage' => 'The specified parameter dedicatedHostGroupId is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceClass.Malformed', 'errorMessage' => 'The specified parameter DBInstanceClass is not valid.', 'description' => ''],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The specified parameter EngineVersion is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'CreditPayInsufficientBalance', 'errorMessage' => 'Insufficient credit pay limit. Please contact your channel partner to increase the limit.', 'description' => 'The quota runs out. Contact your customer service representatives to increase the quota.'],
['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is empty.', 'description' => 'The Tag.N.Key parameter is left unspecified.'],
['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is empty.', 'description' => 'The Tag.N.Value parameter is left unspecified.'],
['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => 'The values of two Tag.N.Key parameters are duplicate.'],
['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => 'The number of tags exceeds 20.'],
['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The parameter ResourceIds.N must not be null.', 'description' => 'The ResourceIds.N parameter cannot be empty.'],
['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The Tag.N.Key parameter is invalid.', 'description' => 'The value of the Tag.N.Key parameter is invalid.'],
['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => 'The Tag.N.Value parameter is invalid.'],
['errorCode' => 'NoPermission.SystemTag', 'errorMessage' => 'You have no permission to use system tags.', 'description' => 'You have no permission to use the system tag.'],
['errorCode' => 'InvalidParam.Amount', 'errorMessage' => 'Amount is allowed from 1 to 20.', 'description' => 'Amount is allowed from 1 to 20.'],
['errorCode' => 'InvalidParam.CreateStrategy', 'errorMessage' => 'Only Atomicity and Partial are allowed.', 'description' => 'Only the Atomicity and Partial parameters are supported.'],
['errorCode' => 'InvalidParam.Engine', 'errorMessage' => 'Only MySQL is allowed when Amount > 1.', 'description' => ''],
['errorCode' => 'InvalidMultiZoneInfoList', 'errorMessage' => 'The Specified Zone Info List is Invaild.', 'description' => ''],
['errorCode' => 'InvalidKmsConfigStatus', 'errorMessage' => 'The Kms Service Config is Invalid.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => ''],
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'InvalidUsedTime', 'errorMessage' => 'UsedTime can not Less than or equal to zero.', 'description' => 'The value of the UsedTime parameter must be greater than 0.'],
['errorCode' => 'Kms.Unauthorized', 'errorMessage' => 'KMS has not been authorized.', 'description' => 'KMS is not authorized.'],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', 'description' => 'The DBParamGroupId parameter specified for creation is invalid.'],
['errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', 'description' => 'The operation failed. The instance name already exists. Specify a different name and try again.'],
['errorCode' => 'ServiceLinkedRole.NotExist', 'errorMessage' => 'Service linked role for RDS PostgreSQL not exist.', 'description' => 'Create the AliyunServiceRoleForRdsPgsqlOnEcs role for ApsaraDB RDS for PostgreSQL.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => '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.', 'description' => 'Hello customer, this area has been abolished.'],
['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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'InvalidPrivateIpAddress.Format', 'errorMessage' => 'The specified private IP address format is incorrect.', 'description' => 'The specified IP address is not in the correct format.'],
['errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', 'description' => 'The VPC endpoint is invalid.'],
['errorCode' => 'TooManyWhitelistTemplateIds', 'errorMessage' => 'create dbinstance can support attach to up to 10 whitelist templates.', 'description' => 'Excessive number of incoming whitelist templates! You can associate up to 10 whitelist templates.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'the template id list is invalid.', 'description' => 'The ID of the specified whitelist template is incorrect. Check the setting.'],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', 'description' => 'The request is copy, check your token.'],
['errorCode' => 'InvalidParameter.MinCapacity', 'errorMessage' => 'The specified parameter \'MinCapacity\' is not valid.', 'description' => 'The specified parameter \'MinCapacity\' is not valid.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidParameter.NotSupportDBInstanceStorageType', 'errorMessage' => 'Parameter DBInstanceStorageType is invalid.', 'description' => 'Invalid DBInstanceStorageType parameter'],
['errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', 'description' => 'Classic network offline, does not support the creation of classic network instances!'],
['errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', 'description' => 'The specified order does not exist in RDS.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => 'The specified vSwitch ID is in an incorrect format.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => 'No credit card is available.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => 'The instance status does not support this operation.'],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'IncorrectTargetCategory', 'errorMessage' => 'Current target category does not support this operation.', 'description' => 'Current target category does not support this operation.'],
['errorCode' => 'PurchaseDurationInsufficient', 'errorMessage' => 'The purchase duration does not meet the requirements, please choose again.', 'description' => 'The purchase duration does not meet the requirements, please select again.'],
['errorCode' => 'NotFound.ParamGroupId', 'errorMessage' => 'Current ParamGroupId not found.', 'description' => 'The parameter template does not exist.'],
['errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', 'description' => 'Xfs instance must be single tenant standard instance.'],
['errorCode' => 'UnsupportedColdData', 'errorMessage' => 'Current coldDataEnabled parameter can not support.', 'description' => 'The specified region does not support cold storage.'],
['errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', 'description' => 'The master switch requires at least 3 available IPs.'],
['errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', 'description' => 'The master switch requires at least 2 available IPs.'],
['errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', 'description' => 'The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.'],
],
[
['errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', 'description' => ''],
],
403 => [
['errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', 'description' => 'The roleArn can not be null.'],
['errorCode' => 'RISK.RISK_CONTROL_REJECTION', 'errorMessage' => 'Risk control rejection.', 'description' => ''],
['errorCode' => 'AliCroup2CloudUserCannotBuyNotInnerCommodity', 'errorMessage' => 'There is no group cloud commodity label, and users within the group are not allowed to purchase.', 'description' => 'The product does not have the group cloud migration tag. Internal group users are not allowed to purchase this product.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => 'The database engine version of the instance is not MySQL 8.0. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => 'The node specifications of the instance are inconsistent. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => 'The number of nodes in the instance is not an odd number greater than or equal to 3. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => 'The instance contains tables that use the X-Engine storage engine. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => 'The instance specification has insufficient memory. MySQL Group Replication is not supported.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'BasicCategoryNotSupport', 'errorMessage' => 'The Basic category is not supported.', 'description' => 'Basic series not supported'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', 'description' => 'This operation is not supported for the character type of the instance.'],
],
[
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', 'description' => 'The target Availability Zone does not have enough resources.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Create an apsaraDB RDS instance',
'summary' => 'Creates an ApsaraDB RDS instance.',
'description' => '### Supported database engines'."\n"
.'- ApsaraDB RDS for MySQL'."\n"
.'- ApsaraDB RDS for PostgreSQL'."\n"
.'- ApsaraDB RDS for SQL Server'."\n"
.'- ApsaraDB RDS for MariaDB'."\n"
."\n"
.'### Related documentation'."\n"
.'>This API operation incurs fees. Read the related documentation carefully before you call this operation.'."\n"
.'If an error message is returned when you call this operation, search for the error message to find the cause.>'."\n"
."\n"
.'- [Create an ApsaraDB RDS for MySQL instance](~~148036~~)'."\n"
.'- [Create an ApsaraDB RDS for MySQL Serverless instance](~~412231~~)'."\n"
.'- [Create an ApsaraDB RDS for PostgreSQL instance](~~148038~~)'."\n"
.'- [Create an ApsaraDB RDS for PostgreSQL Serverless instance](~~607753~~)'."\n"
.'- [Create a Babelfish for RDS PostgreSQL instance](~~428615~~)'."\n"
.'- [Create an ApsaraDB RDS for SQL Server instance](~~148037~~)'."\n"
.'- [Create an ApsaraDB RDS for SQL Server Serverless instance](~~603465~~)'."\n"
.'- [Create an ApsaraDB RDS for MariaDB instance](~~148040~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '>使用新版SDK包调用本接口时,由于SDK内部的客户端默认超时时间和服务端的不一致,因此可能返回请求超时的错误,但实际上接口已调用成功。如需避免这个问题,您可以在调用前设置ReadTimeout参数为20000。'."\n"
.'',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-02T09:13:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-03T13:01:03.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-19T13:27:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-31T06:37:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-24T10:41:00.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-24T13:20:39.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-29T03:47:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-27T13:13:45.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-14T10:28:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-25T13:06:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-23T14:34:18.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-07-05T06:48:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:04.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-24T06:10:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-16T03:19:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T12:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T03:57:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T01:37:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-25T13:37:27.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-03-26T13:15:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-27T12:22:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-02T06:16:26.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-04T11:54:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-06T02:39:18.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-06T02:21:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-01T16:23:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-04-18T10:20:00.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-04-11T01:38:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-30T07:22:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-15T02:28:52.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2022-12-22T02:53:26.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-27T02:34:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-13T06:30:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-13T06:30:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-31T14:49:48.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-22T13:07:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-02-28T16:24:19.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-02-28T16:24:19.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-12-15T11:20:45.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:Engine'],
['conditionKey' => 'rds:EngineVersion'],
['conditionKey' => 'rds:DBInstanceClass'],
['conditionKey' => 'rds:DBInstanceStorage'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'translator' => 'machine',
],
'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****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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' => '', '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' => '',
'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' => '', '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-****', 'title' => ''],
'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rn-xxxx-****', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceEndpointId' => ['description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C8E88DED-533F-4B3C-9207-731FBF394CCA', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is too many.', 'description' => ''],
['errorCode' => 'InvalidNodeItems.DuplicateNodeId', 'errorMessage' => 'Duplicate nodeId, please ensure all nodeIds are different.', 'description' => 'Duplicate NodeId parameter values exist in NodeItems.'],
['errorCode' => 'InvalidNodeItems.RONode', 'errorMessage' => 'ReadOnly endpoint can not contain readonly instance node.', 'description' => 'The read-only endpoint cannot contain the read-only instance.'],
['errorCode' => 'InvalidNodeItems.RONodeIdPrimary', 'errorMessage' => 'ReadOnly endpoint can not contain primary node.', 'description' => 'The read-only endpoint cannot contain the primary instance.'],
['errorCode' => 'InvalidNodeItems.JsonFormat', 'errorMessage' => 'NodeItems is not a json string.', 'description' => 'The NodeItems parameter value must be a JSON string.'],
['errorCode' => 'InvalidNodeItems.DBInstanceId', 'errorMessage' => 'Specified dbInstanceId is invalid', 'description' => 'The specified dbInstanceId parameter in NodeItems is invalid.'],
['errorCode' => 'InvalidNodeItems.NodeId', 'errorMessage' => 'Specified Node id is invalid', 'description' => 'A NodeId parameter value in NodeItems is not found among instances.'],
['errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', 'description' => 'The specified endpoint type is invalid.'],
['errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint already exist.', 'description' => ''],
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api called failed, please check vpc vsw vip', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidNodeItems.BlackNodeItems', 'errorMessage' => 'NodeItems is blank.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', 'description' => 'The specified VPC ID is invalid.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['errorCode' => 'InvalidWeight.Format', 'errorMessage' => 'The Specified Weight format is not valid.', 'description' => 'The weight range is invalid.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-11-07T09:25:23.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-27T10:02:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBInstanceEndpoint',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceEndpoint'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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' => '',
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceEndpointId' => ['description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', 'description' => 'The specified endpoint type is invalid.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.'],
['errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', 'description' => ' '],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-06-27T10:02:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-12T15:50:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-09T12:13:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBInstanceEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testdb', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6f7l4fg90****', 'title' => ''],
],
[
'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-uf6adz52c2p****', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'Message' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '20793850608****', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'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.', 'description' => 'A security risk was detected in the default payment method. Please verify your payment method before placing your order. A verification link will be sent to you via email and internal message.'],
['errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'InvalidZone.NotSupportedForStorageType', 'errorMessage' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', 'description' => ''],
['errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', 'description' => 'A switchover for high availability is in progress. Please wait.'],
['errorCode' => 'InvalidEngine.VauleNotSupported', 'errorMessage' => 'The specified parameter "Engine" is not valid.', 'description' => 'The database engine is invalid. The database engine must be MySQL, SQL Server, PostgreSQL, or PPAS.'],
['errorCode' => 'InvalidEngineVersion.ValueNotSupported', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The version of database engines version failed the verification check. Valid values:'."\n"
.'MySQL: 5.5, 5.6, and 5.7.'."\n"
.'SQL Server: 2008r2 and 2012.'."\n"
.'PostgreSQL: 9.4.'."\n"
.'PPAS: 9.3.'],
['errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', 'description' => 'The specified parameter DBinstanceClass is invalid.'],
['errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceStorage" is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceDescription.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceDescription" is not valid.', 'description' => 'The instance description failed the verification check. The description must be 2 to 256 characters in length and can contain letters, underscores (_), and hyphens (-). The description must start with a letter and cannot start with http:// or https://.'],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The IP address whitelist is invalid. The whitelist contains duplicate entries.'],
['errorCode' => 'InvalidSecurityIPListLength.Malformed', 'errorMessage' => 'The quota of security ip exceeds.', 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist reaches the upper limit.'],
['errorCode' => 'DefaultVpc.NotSupport', 'errorMessage' => 'The default vpc create is not support.', 'description' => ' '],
['errorCode' => 'Forbidden.RegionNotFound', 'errorMessage' => 'The provided RegionId does not exist in our record.', 'description' => 'The operation failed. The region ID cannot be found.'],
['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', 'description' => 'The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.'],
['errorCode' => 'InvalidVpcId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', 'description' => 'The operation failed. Check that the VPC or the vSwitch resides in the same zone as the RDS instance.'],
['errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.'],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', 'description' => 'No available IP address exists in the specified vSwitch.'],
['errorCode' => 'InvalidGeneralGroupName.Malformed', 'errorMessage' => 'The specified parameter GeneralGroupName is not valid.', 'description' => 'The value of the GeneralGroupName parameter is invalid.'],
['errorCode' => 'AccountBasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your information is incomplete. Complete your information and try again.'],
['errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', 'description' => 'The value of the VPCId parameter is invalid. Specify a valid value.'],
['errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'Operation is denied by the current database instance status.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The number of available zones does not match the database engine or instance edition. Please reset it.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', 'description' => 'Classic network offline, does not support the creation of classic network instances!'],
],
403 => [
['errorCode' => 'ClassicNetworkType.NotSupport', 'errorMessage' => 'The Classic instance network create is not support.', 'description' => 'The current instance cannot be deployed in the classic network. Change the network type to VPC.'],
['errorCode' => 'InvalidEngineVersionInRegion.NotAvailable', 'errorMessage' => 'The EngineVersion in the Region is not available.', 'description' => 'The database engine version is not supported in the region.'],
['errorCode' => 'OperationDenied', 'errorMessage' => 'The specified request is out of resources.', 'description' => 'The specified request resource is insufficient.'],
['errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', 'description' => 'The maximum number of instances has been exceeded. Release the instances that are no longer needed.'],
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'INST_HAS_UNPAID_ORDER', 'errorMessage' => 'The instanceId has unpaid order.', 'description' => 'You have an unpaid order for the instance. Pay for or cancel the order and try again.'],
['errorCode' => 'COMMODITY.FAILED', 'errorMessage' => 'The commodity is error.', 'description' => 'A server error occurred. Contact O&M engineers.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'Your account balance is insufficient. Add funds to your account.'],
['errorCode' => 'OperationDenied.ClassicNetworkType', 'errorMessage' => 'The operation is not permitted due to status of instance.', 'description' => 'The Classic network type does not support the current operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['errorCode' => 'CreateOrder.Failed', 'errorMessage' => 'Create Order Failed.', 'description' => 'Failed to create the purchase order.'],
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'The region ID cannot be found. Check the region ID.'],
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'QueryPrice Failed.', 'description' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-12-26T03:06:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-18T06:44:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-14T06:00:54.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-04-06T11:28:56.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-03-16T05:30:31.000Z', 'description' => 'Error codes changed, Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBInstanceForRebuild',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceForRebuild'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CreateDBInstanceReplication' => [
'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.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the `DescribeDBInstances` operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1234567890abcdef', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'ChannelName',
'in' => 'query',
'schema' => ['description' => 'A unique name for the replication channel. This name identifies the replication link.', 'type' => 'string', 'example' => 'replication-channel-001', 'maxLength' => 64, 'required' => false, 'title' => ''],
],
[
'name' => 'MasterHost',
'in' => 'query',
'schema' => ['description' => 'The endpoint of the primary database, which can be an IP address or a domain name.', 'type' => 'string', 'required' => true, 'example' => '192.168.1.100', 'maxLength' => 128, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'MasterPort',
'in' => 'query',
'schema' => ['description' => 'The port of the primary database. For example, the default port for MySQL is 3306.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '3306', 'title' => ''],
],
[
'name' => 'MasterUser',
'in' => 'query',
'schema' => ['description' => 'The username for the replication account on the primary database.', 'type' => 'string', 'required' => true, 'example' => 'repl_user', 'maxLength' => 32, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'MasterPassword',
'in' => 'query',
'schema' => ['description' => 'The Base64-encoded password for the replication user account.', 'type' => 'string', 'required' => true, 'example' => 'U2VjdXJlUGFzczEyMyE=', 'maxLength' => 44, 'minLength' => 8, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-9818-CF1DC482C092'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidReplicationChannel.Duplicate', 'errorMessage' => 'Specified replication channel already exists.', 'description' => 'Specified replication channel already exists.'],
['errorCode' => 'InvalidReplicationChannelName.Forbid', 'errorMessage' => 'Specified replication channel name is forbidden (reserved for internal use).', 'description' => 'Specified replication channel name is forbidden (reserved for internal use).'],
['errorCode' => 'MissingReplicationParam', 'errorMessage' => 'Missing required parameters for replication operation: MasterHost, MasterPort, MasterUser, MasterPassword.', 'description' => 'Missing necessary replication-related parameters'],
['errorCode' => 'InvalidMasterPort.Format', 'errorMessage' => 'Specified MasterPort format is not valid.', 'description' => 'Specified MasterPort format is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create replication channel ',
'summary' => 'Creates a replication link for a native replication instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76364A52-E0AB-5CC8-9818-CF1DC482C092\\"\\n}","type":"json"}]',
],
'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******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the security group rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zht_test', 'title' => ''],
],
],
'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', 'title' => ''],
'Message' => ['description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F4'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingPortRange', 'errorMessage' => 'The request is missing a portRange parameter.', 'description' => 'The request is missing a portRange parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => '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",
'changeSet' => [
['createdAt' => '2024-10-09T05:04:48.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBInstanceSecurityGroupRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceSecurityGroupRule'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'vswitchId' => ['description' => 'The vSwitch ID of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1sxxsodv28ey5dl****', 'title' => ''],
'zoneId' => ['description' => 'The ID of the zone in which the node is deployed.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou-a', 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 7,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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*****', 'title' => ''],
],
],
'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****', 'title' => ''],
'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****', 'title' => ''],
'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2133400000****', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', 'description' => 'You must specify the dbNode parameter.'],
['errorCode' => 'DBNodeParameterTooManyItems', 'errorMessage' => 'The specified parameter DBNode has too many items.', 'description' => 'An excessive number of nodes are added for dbNode.'],
['errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', 'description' => 'The ClassCode configuration is invalid for the DBNode parameter.'],
['errorCode' => 'DBNodeParameter.InvalidValue', 'errorMessage' => 'The specific param DBNode is not valid.', 'description' => ''],
['errorCode' => 'DBNodeParameter.NotFound', 'errorMessage' => 'The specified parameter DBNode is not valid.', 'description' => ''],
['errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', 'description' => ''],
['errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', 'description' => 'The specification code in the parameter is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', 'description' => 'The specified order does not exist in RDS.'],
],
403 => [
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-03-31T08:25:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-23T14:04:18.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-03-22T04:49:30.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-23T07:45:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-07T09:25:22.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-10-20T03:11:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-10-19T16:51:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-24T13:47:21.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-27T10:02:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-03-22T12:26:20.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
['createdAt' => '2022-12-16T05:31:13.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBNodes',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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', 'title' => ''],
],
[
'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-t4n3****', 'title' => ''],
],
[
'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-t4n3****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-bp****', 'title' => ''],
],
[
'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-bp****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => ''],
['errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', 'description' => ''],
['errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'Specified vpc instance id is not valid.', 'description' => 'The specified VPC ID is invalid.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The specified vpcId or vSwitchId is not supported.', 'description' => 'The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.'],
['errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', 'description' => 'The VPC endpoint is invalid.'],
['errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', 'description' => 'The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.'],
['errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', 'description' => ''],
['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified vSwitch is not found in specified VPC.', 'description' => 'No vSwitch is found in the VPC.'],
['errorCode' => 'InvalidVSwitchId.Mismatch', 'errorMessage' => 'Specified instance and virtual switch are not in the same zone.', 'description' => 'The RDS instance and the vSwitch are not in the same zone.'],
['errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', 'description' => 'The IP address has been used.'],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', 'description' => 'No available IP address exists in the specified vSwitch.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => ''],
['errorCode' => 'InvalidDBProxyConnectStringNetType.NotSupported', 'errorMessage' => 'The Specified DBProxyConnectStringNetType is not supported.', 'description' => 'The specified DBProxyConnectStringNetType value is not supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', 'description' => 'The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', 'description' => 'Current cluster resources are insufficient. Try again later.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-24T09:44:10.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-27T15:31:18.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-13T09:26:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-13T09:30:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-03T14:57:47.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-08T14:33:17.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDBProxyEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:DBProxyConnectStringNetType'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBProxyEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testdb', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when the instance is being migrated across engines.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidDescription.Format', 'errorMessage' => 'Specified description is not valid.', 'description' => 'The description is invalid.'],
['errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', 'description' => 'Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.'],
['errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified account name is a keyword in RDS.', 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.'],
['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', 'description' => 'Your account does not have the required permissions.'],
['errorCode' => 'IncorrectDBInstanceServiceType', 'errorMessage' => 'Current DB instance top type does not support this operation.', 'description' => ''],
['errorCode' => 'Database.AddError', 'errorMessage' => 'Create Db failed, please check input value and instance status.', 'description' => 'Failed to create the database. Check the specified parameters and the instance status.'],
['errorCode' => 'Database.QueryError', 'errorMessage' => 'invalid value, may include special character.', 'description' => 'The value is invalid and may contain special characters.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Due to the limit number you can\'t create a database.', 'description' => ''],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'InvalidDBInstanceIdOrDBInstanceName', 'errorMessage' => 'The specified params DBInstanceId or DBInstanceName should not be empty.', 'description' => 'The specified parameter DBInstanceId or DBInstanceName should not be empty.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-16T09:38:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-13T12:55:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-06-04T06:14:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T06:07:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-03T05:06:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-11T08:51:14.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-03-24T14:06:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-24T14:06:45.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatabase'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDatabase',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A77D650-27A1-4E08-AD9E-59008EDB6927\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testdb', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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.XX.XX.69', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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****', 'title' => ''],
],
[
'name' => 'BackupSetRegion',
'in' => 'query',
'schema' => ['description' => 'The region where the backup set is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****-****-****-****', 'title' => ''],
],
],
'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-****.mysql.rds.aliyuncs.com', 'title' => ''],
'DBInstanceId' => ['description' => 'The destination instance ID.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '2038691****', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E52666CC-330E-418A-8E5B-A19E3FB42D13', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.'],
['errorCode' => 'InvalidDBInstanceName.Format', 'errorMessage' => 'Specified DB instance name is not valid.', 'description' => 'The instance does not exist. Check the instance information.'],
['errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', 'description' => 'The operation failed. The instance name already exists. Specify a different name and try again.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidServiceType.Format', 'errorMessage' => 'Specified service type is not valid.', 'description' => 'The service type is invalid. Set the service type to 0 or 1. The value 0 indicates an Alibaba Cloud service, and the value 1 indicates a JST service.'],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => ''],
['errorCode' => 'InvalidCharacterSetName.Format', 'errorMessage' => 'Specified character set name is not valid.', 'description' => 'The character set is invalid. ApsaraDB RDS supports the following character sets: gbk, utf8, euckr, and ascii.'],
['errorCode' => 'InvalidDBInstanceType.Format', 'errorMessage' => 'Specified instance type is not valid.', 'description' => 'The operation failed. The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'Specified backup retention period is not valid.', 'description' => 'The backup cycle is invalid. The backup cycle must be greater than 1 day and less than or equal to 30 days.'],
['errorCode' => 'InvalidPreferredBackupTime.Format', 'errorMessage' => 'Specified preferred backup time is not valid.', 'description' => 'The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['errorCode' => 'InvalidPreferredBackupPeriod.Malformed', 'errorMessage' => 'Specified backup period is not valid.', 'description' => 'The backup time is invalid.'],
['errorCode' => 'InvalidOptmizationService', 'errorMessage' => 'Specified optmization service is not valid.', 'description' => ''],
['errorCode' => 'InvalidExpiredTime.Format', 'errorMessage' => 'Specified expired time is not valid.', 'description' => 'The value of the ExpiredTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'],
['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => 'The IP address whitelist is invalid. Check the IP address whitelist.'],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => 'The IP address whitelist is invalid. The whitelist contains duplicate entries.'],
['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.'],
['errorCode' => 'InvalidDBInstanceDescription.Format', 'errorMessage' => 'Specified DB instance description is not valid.', 'description' => ''],
['errorCode' => 'InvalidStorage.Format', 'errorMessage' => 'Specified Storage is not valid.', 'description' => 'The value of the Storage parameter is invalid. Specify a valid value.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'PreCheckInvalid', 'errorMessage' => 'CreateDdrInstance PreCheck Is Invalid', 'description' => 'The precheck for CreateDdrInstance is invalid.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => ''],
['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['errorCode' => 'NoBackupSetRegion', 'errorMessage' => 'BackupSetRegion is absence.', 'description' => 'The backup region does not exist.'],
['errorCode' => 'IncorrectBackupSetType', 'errorMessage' => 'Backup set type should be value ddr.', 'description' => ''],
['errorCode' => 'NoBaksetName', 'errorMessage' => 'BaksetName is absence.', 'description' => 'The backup set name does not exist.'],
['errorCode' => 'NoSourceInstanceName', 'errorMessage' => 'No SourceDBInstanceName.', 'description' => 'The source instance name is not found.'],
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', 'description' => 'No available restore set is found.'],
['errorCode' => 'InvalidBackupType.Format', 'errorMessage' => 'Specified backup type is not valid.', 'description' => 'The operation failed. The backup type is invalid.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.'],
['errorCode' => 'DisasterRestoreRegionNotMatched', 'errorMessage' => 'Disaster restore should be operated in the ddr region or source region.', 'description' => ''],
['errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', 'description' => 'No available IP address exists in the specified vSwitch.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', 'description' => 'The operation failed. The data backup file does not support the restoration of individual databases and tables.'],
['errorCode' => 'IncorrectBaksetVersion', 'errorMessage' => 'Current bakset version does not support operations.', 'description' => ''],
['errorCode' => 'CrossRegionUnsupportTDE', 'errorMessage' => 'Cross-region disaster restore not support TDE bakset.', 'description' => ''],
['errorCode' => 'OperationDenied.Resource', 'errorMessage' => 'Specified DB instance class or storage is not available in all Availability Zones.', 'description' => 'Insufficient resources. Try again with a different instance type or storage size.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', 'description' => 'The region ID is invalid.'],
['errorCode' => 'InvalidClusterName.NotFound', 'errorMessage' => 'The specified cluster name is not available.', 'description' => 'The operation failed. The instance name cannot be found. Check the instance name and try again.'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['errorCode' => 'InvalidDBInstanceNetType.NotFound', 'errorMessage' => 'Specified DB instance net type is not found.', 'description' => 'The operation failed. The network type of the RDS instance is invalid. Specify a valid network type.'],
['errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', 'description' => 'RestoreType is not found.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-02-28T06:26:22.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-02-28T05:35:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-02-27T15:30:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-27T08:00:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2024-05-29T05:31:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-27T07:09:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-14T05:42:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-01-11T06:42:43.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-05-26T06:31:30.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateDdrInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDdrInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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 } } } }', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The name of the global active database cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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, 'title' => ''],
'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', 'title' => ''],
'VSwitchID' => ['description' => 'The vSwitch ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1tg609m5j85****', 'title' => ''],
'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****', 'title' => ''],
'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-j', 'title' => ''],
'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-j', 'title' => ''],
'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-j', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'CentralRdsDtsAdminPassword',
'in' => 'query',
'schema' => ['description' => 'The password of the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test12345', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'GadInstanceName' => ['description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8****', 'title' => ''],
'TaskID' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '5374****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotActive', 'errorMessage' => 'gad instance not in active ', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGAD', 'errorMessage' => 'CentralNode DB not support GAD', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmpty', 'errorMessage' => 'UnitMemberParams not valid', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsError', 'errorMessage' => 'UnitMemberParams not valid', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNode', 'errorMessage' => 'the gadInstanceName not match with the central node', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceExists', 'errorMessage' => 'gad instance has exists,please add member!', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceNotExists', 'errorMessage' => 'gad instance not exists,please create GAD!', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotFound', 'errorMessage' => 'gad instance not Found', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabase.GetInstanceMemberFaied', 'errorMessage' => 'get instance member list failed', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckGadInstance', 'errorMessage' => 'exceed max member count 10', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckMemberParams', 'errorMessage' => 'centralNode not exists', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-12-15T08:23:24.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-11T08:51:14.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-10T08:04:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-19T15:04:16.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateGADInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'GadInstance', 'arn' => 'acs:rds::{#accountId}:gadinstance/*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGADInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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', 'title' => ''],
],
[
'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' => 'rm-bp190h8y69tad****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'VSwitchID' => ['description' => 'The vSwitch ID of the unit node that you want to create.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1tg609m5j85****', 'title' => ''],
'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****', 'title' => ''],
'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-j', 'title' => ''],
'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-j', 'title' => ''],
'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-j', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 9,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'CentralRdsDtsAdminPassword',
'in' => 'query',
'schema' => ['description' => 'The password of the privileged account of the central node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Test12345', 'title' => ''],
],
[
'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 } } } }', 'title' => ''],
],
],
'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', 'title' => ''],
'GadInstanceName' => ['description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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.', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotActive', 'errorMessage' => 'gad instance not in active', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.CentralNodeNotSupportGAD', 'errorMessage' => 'CentralNode DB not support GAD', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsEmpty', 'errorMessage' => 'UnitMemberParams not valid', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.UnitMemberParamsError', 'errorMessage' => 'UnitMemberParams not valid', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadNameNotMatchCentralNode', 'errorMessage' => 'the gadInstanceName not match with the central node', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceExists', 'errorMessage' => 'gad instance has exists,please add member!', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseFailed.GadInstanceNotExists', 'errorMessage' => 'gad instance not exists,please create GAD!', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabase.GadInstanceNotFound', 'errorMessage' => 'gad instance not Found', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabase.GetInstanceMemberFaied', 'errorMessage' => 'get instance member list failed', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckGadInstance', 'errorMessage' => 'exceed max member count 10', 'description' => ''],
['errorCode' => 'CreateGlobalActiveDatabaseImpl.preCheckMemberParams', 'errorMessage' => 'centralNode not exists', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-12-15T09:50:38.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-23T13:22:42.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-19T15:04:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-19T15:04:16.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateGadInstanceMember',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGadInstanceMember'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CreateImportTask' => [
'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' => 'The region ID. You can call the [DescribeRegions](~~610399~~) operation to query the latest region list.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Host',
'in' => 'query',
'schema' => ['description' => 'The IP address of the source MySQL database. RDS accesses this IP address to obtain a backup.', 'type' => 'string', 'required' => true, 'example' => '172.20.246.90', 'title' => ''],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => 'The port of the source MySQL database.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65536', 'minimum' => '1', 'example' => '3306', 'title' => ''],
],
[
'name' => 'StreamPort',
'in' => 'query',
'schema' => ['description' => 'The streaming port used to transfer the backup.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '9999', 'title' => ''],
],
[
'name' => 'User',
'in' => 'query',
'schema' => ['description' => 'The user of the source MySQL database. This user requires permissions to create backups and set up replication. For more information, see the following sample SQL statements:'."\n"
."\n"
.'```'."\n"
.'-- MySQL 5.7'."\n"
.'mysql> CREATE USER \'myadmin\'@\'%\' IDENTIFIED BY \'s3cret\';'."\n"
.'mysql> GRANT RELOAD, LOCK TABLES, PROCESS, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO'."\n"
.' \'myadmin\'@\'%\';'."\n"
.'mysql> FLUSH PRIVILEGES;'."\n"
.'-- MySQL 8.0'."\n"
.'mysql> CREATE USER \'myadmin\'@\'%\' IDENTIFIED BY \'Test123!\';'."\n"
.'mysql> GRANT BACKUP_ADMIN, PROCESS, RELOAD, LOCK TABLES, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO \'myadmin\'@\'%\';'."\n"
.'mysql> GRANT SELECT ON performance_schema.log_status TO \'myadmin\'@\'%\';'."\n"
.'mysql> GRANT SELECT ON performance_schema.keyring_component_status TO myadmin@\'%\';'."\n"
.'mysql> GRANT SELECT ON performance_schema.replication_group_members TO myadmin@\'%\';'."\n"
.'mysql> FLUSH PRIVILEGES;'."\n"
.'```', 'type' => 'string', 'required' => true, 'example' => 'myadmin', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password for the source MySQL user. It must be Base64-encoded.', 'type' => 'string', 'required' => true, 'example' => 'OEF5JjVOM2pzZXFKRw==', 'title' => ''],
],
[
'name' => 'SourcePlatform',
'in' => 'query',
'schema' => [
'description' => 'The type of the cloud instance that hosts the source database.',
'type' => 'string',
'enum' => ['ECS', 'RdsCustom'],
'required' => false,
'example' => 'ECS',
'title' => '',
],
],
[
'name' => 'SourceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the cloud instance that hosts the source database.', 'type' => 'string', 'required' => false, 'example' => 'i-bp1fe296n52ub3chezpg', 'title' => ''],
],
[
'name' => 'XtrabackupPath',
'in' => 'query',
'schema' => ['description' => 'The installation path of xtrabackup on the source server.', 'type' => 'string', 'required' => false, 'example' => '/usr/bin/xtrabackup', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the destination RDS instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1u*****ggm7j9j', 'title' => ''],
],
[
'name' => 'EstimatedSize',
'in' => 'query',
'schema' => ['description' => 'The estimated data size, in GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2'],
'TaskId' => ['description' => 'The import task ID.', 'type' => 'string', 'example' => '3384382', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'INVALID_SOURCE_INSTANCE.RDS_CUSTOM', 'errorMessage' => 'Source RdsCustom instance is not valid to import, please check instance attributes.', 'description' => 'The source RdsCustom instance cannot be used for RDS data import. Check the instance properties.'],
['errorCode' => 'InvalidParam', 'errorMessage' => '%s.', 'description' => 'Parameter error, please check the parameters.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a Data Import Job ',
'description' => 'Creates a data import task to import data into an RDS for MySQL instance that uses native replication.',
'summary' => 'Creates a data import task.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateImportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"TaskId\\": \\"3384382\\"\\n}","type":"json"}]',
],
'CreateMaskingRules' => [
'summary' => 'Create a new encryption or desensitization rule for a specified instance.',
'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' => 'Rule Name (only one rule name is supported per request) ', 'type' => 'string', 'required' => true, 'example' => 'rulename1', 'title' => ''],
],
[
'name' => 'MaskingAlgo',
'in' => 'query',
'schema' => ['description' => 'Rule algorithm. Multiple algorithms can be selected. Masking Algorithm can include additional parameters. Format: {name: algorithm1}, {name: algorithm2, params: {encryption position, number of encrypted characters}} ', 'type' => 'string', 'required' => false, 'example' => '[{"name": "aes-128-gcm"},'."\n"
.' {"name":"sm4-128-gcm"}]', 'title' => ''],
],
[
'name' => 'DefaultAlgo',
'in' => 'query',
'schema' => ['description' => 'Name of the default encryption or masking algorithm', 'type' => 'string', 'required' => false, 'example' => 'aes-128-gcm', 'title' => ''],
],
[
'name' => 'RuleConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Rule configuration, in JSON string format, containing matching rules for databases, tables, and columns',
'type' => 'object',
'properties' => [
'Columns' => [
'description' => 'List of columns',
'type' => 'array',
'items' => ['description' => '* indicates all', 'type' => 'string', 'maxLength' => 100, 'minLength' => 1, 'required' => false, 'example' => 'a', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
'Databases' => [
'description' => 'List of databases',
'type' => 'array',
'items' => ['description' => '* indicates all', 'type' => 'string', 'maxLength' => 100, 'minLength' => 1, 'required' => false, 'example' => 'testdb', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
'Tables' => [
'description' => 'List of tables',
'type' => 'array',
'items' => ['description' => '* indicates all ', 'type' => 'string', 'maxLength' => 100, 'minLength' => 1, 'required' => false, 'example' => 'testtb', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'instance ID ', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o3*****d5', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID ', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'Database name', 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'Returned data',
'type' => 'object',
'additionalProperties' => ['description' => 'Instance name', 'type' => 'string', 'example' => 'rm-t4n8t18o******d5', 'title' => ''],
'title' => '',
'example' => '',
],
'Message' => ['description' => 'Return message', 'type' => 'string', 'example' => 'successful create', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '792233B1-76B8-5A01-92B4-**********864'],
'Success' => ['description' => 'Indicates whether the request succeeded. Return values:'."\n"
."\n"
.'- **true**: Succeeded'."\n"
.'- **false**: Failed', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectParameter.%s', 'errorMessage' => 'The following parameters are incorrect: %s.', 'description' => 'The parameter is incorrect.'],
['errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', 'description' => 'The value of the parameter is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', 'description' => 'The parameter is not found for the interface.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created and whether the RDS instance has not been deleted.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create an Encryption or Desensitization Rule',
'description' => '## Request Description'."\n"
.'- Before using this API, ensure that you have enabled the column encryption service in DAS Security Center.'."\n"
.'- If you receive the error message ColumnEncryptionErrorCode.NOT_PURCHASED when invoking the API, go to the DAS (Database Autonomy Service) Security Center to purchase and enable the column encryption service before using it again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'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"}]',
'translator' => 'machine',
],
'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', '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****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the destination database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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.******.mobi ', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test02', 'title' => ''],
'MigrateTaskId' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '564563****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '866F5EB8-4650-4061-87F0-379F6F968BCE', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '545****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The DB instance type does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the instance type of the RDS instance.'],
['errorCode' => 'InvalidInstanceLockMode', 'errorMessage' => 'The DB instance lock mode does not support this operation.', 'description' => 'This operation is not supported for the lock mode of the RDS instance.'],
['errorCode' => 'InvalidDBName', 'errorMessage' => 'The instance does not have the specified DB name.', 'description' => ''],
['errorCode' => 'InvalidDBType', 'errorMessage' => 'The DB type does not support this operation.', 'description' => 'The DB type does not support this operation.'],
['errorCode' => 'InvalidDBState', 'errorMessage' => 'The DB state does not support this operation.', 'description' => 'The operation failed. The database is not in a ready state.'],
['errorCode' => 'ExceedUploadTime', 'errorMessage' => 'Exceeding the daily upload times of this DB.', 'description' => 'The number of downloads on the day exceeds the maximum number of downloads that are allowed per day.'],
['errorCode' => 'InvalidOSSURL', 'errorMessage' => 'The Specified OSS URL is not valid', 'description' => 'The endpoint of the OSS bucket is incorrect.'],
['errorCode' => 'ExceedDiskSize', 'errorMessage' => 'The file size exceeding the disk size', 'description' => 'The size of the file exceeds the available storage space. Check the available storage space and try again.'],
['errorCode' => 'EntityNotExist.Role', 'errorMessage' => 'The role not exists', 'description' => ''],
['errorCode' => 'DatabaseMustOnline', 'errorMessage' => 'Database must be taken online when task type is 0 or 1.', 'description' => 'The database must be connected if the task type is 0 or 1.'],
['errorCode' => 'InvalideStatus', 'errorMessage' => 'Parent migrate task status is invalid.', 'description' => 'The parent migration task is abnormal.'],
['errorCode' => 'InvalidOssObjectStorageClassType', 'errorMessage' => 'The specified OSS bucket storage type is invalid.', 'description' => 'The storage class of the OSS bucket that stores the file is invalid.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', 'description' => 'Instance cloning is not supported for the database engine version of the current instance.'],
['errorCode' => 'BakFileSizeExceeded', 'errorMessage' => 'Exceeding the allowed backup file size.', 'description' => 'Backup file size exceeds allowed value.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', 'description' => 'The operation failed. The RDS instance is unavailable.'],
['errorCode' => 'InvalidOssObjectPositions.Format', 'errorMessage' => 'The specified params OssObjectPositions is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectFileExtension', 'errorMessage' => 'The file extension does not support, we only support extensions like bak, trn, diff, log.', 'description' => 'The file extension is not supported. Only file types with bak,trn,diff, and log suffixes are supported.'],
],
[
['errorCode' => 'BakFilesNeeded', 'errorMessage' => 'Backup file does not supply.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-29T05:31:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-28T08:18:43.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMigrateTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testDB', 'title' => ''],
],
[
'name' => 'MigrateTaskId',
'in' => 'query',
'schema' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5652255443', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', 'description' => 'Instance cloning is not supported for the database engine version of the current instance.'],
['errorCode' => 'InvalideStatus', 'errorMessage' => 'Parent migrate task status is invalid.', 'description' => 'The parent migration task is abnormal.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOnlineDatabaseTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateOnlineDatabaseTask',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-8vb9******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => 'The resources.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
],
[
'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-00c8******', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID'."\n", 'type' => 'string', 'example' => 'rm-7x******', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '221172852******', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49BC2500-8078-5AC4-A545-20AA5945B0E6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'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.', 'description' => '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.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'DBNodeIdParameterInvalid', 'errorMessage' => 'The specified parameter DBNodeId is malformed.', 'description' => 'The specified DBNodeId parameter is invalid.'],
['errorCode' => 'DBNodeIdParameterNotFound', 'errorMessage' => 'The specified parameter DBNodeId is required.', 'description' => 'You must specify the DBNodeId parameter.'],
['errorCode' => 'DBNodeParameterTooFewItems', 'errorMessage' => 'The specified parameter DBNode has too few items.', 'description' => 'An excessive number of nodes are deleted for dbNode.'],
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrderForDeleteDBNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:CreateOrderForDeleteDBNodes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', 'description' => 'The value of the Parameters parameter is invalid. Specify a valid value.'],
['errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The specified parameter group name is invalid.', 'description' => 'The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter.'],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'ParamGroupsDbTypeNotSupport', 'errorMessage' => 'The parameter group does not support the specified database type.', 'description' => 'The parameter template is supported only for RDS instances that run MySQL.'],
['errorCode' => 'ParamGroupsDbVersionNotSupport', 'errorMessage' => 'The parameter group does not support the database version.', 'description' => 'The parameter template is supported only for RDS instances that run MySQL 5.6, MySQL 5.7, or MySQL 8.0.'],
['errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', 'description' => 'The parameter does not exist. Check parameter configurations.'],
['errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', 'description' => 'The parameter type is invalid.'],
['errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', 'description' => 'The paramGroups does not exist or its type is not supported.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', 'description' => ''],
['errorCode' => 'ParamGroupsDescInvalid', 'errorMessage' => 'The maximum length of parameter group description is exceeded.', 'description' => 'The description of the parameter template can be up to 200 characters in length.'],
['errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', 'description' => 'The value of the parameter is invalid.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2023-05-09T13:07:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-01T09:00:35.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateParameterGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParameterGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'Current account privilege type does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-09-09T09:35:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-07T12:21:23.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-07-26T01:55:15.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePostgresExtensions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreatePostgresExtensions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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_auto', 'default' => 'cloud_auto', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-h', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'none', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testDisk', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ac****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DiskId' => ['description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'example' => 'rcd-2zegrjtnkp6dqbe1****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '100789370230206', 'title' => ''],
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => 'No credit card is available.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => 'The instance status does not support this operation.'],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'InvalidSnapshotIds.Malformed', 'errorMessage' => 'The specified snapshotId is not valid.', 'description' => 'the specified snapshot id is invalid, and the information of the user snapshot id is not obtained.'],
['errorCode' => 'InvalidParameter.InstanceChargeType', 'errorMessage' => 'Please input a PREPAY instanceId when creating a PREPAY disk.', 'description' => 'You can only create a PREPAY cloud disk and attach it to a PREPAY instance.'],
['errorCode' => 'InvalidDataDiskCategory.NotSupported', 'errorMessage' => 'Specified disk category is not supported.', 'description' => 'The specified cloud disk type is not supported.'],
['errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified parameter "Description" is not valid.', 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['errorCode' => 'InvalidDiskCategory.ValueNotSupported', 'errorMessage' => 'Specified disk category is not supported.', 'description' => 'The specified cloud disk type is not supported.'],
['errorCode' => 'InvalidDiskSize.NotSupported', 'errorMessage' => 'The specified parameter size is not valid.', 'description' => 'The specified disk capacity is invalid.'],
['errorCode' => 'InvalidZoneId.DiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support setting the ZoneId.', 'description' => 'The specified disk type does not support setting the Availability Zone.'],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => '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.', 'description' => 'Elastic temporary disks do not support snapshot recovery or snapshot creation.'],
['errorCode' => 'Invalid.RCInstanceExpired', 'errorMessage' => 'The requested custom instance has expired.', 'description' => 'The instance has expired and the operation is not supported.'],
['errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', 'description' => 'The parameter PerformanceLevel of the specified data disk is invalid.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InvalidOperation.DataDiskNotSupport', 'errorMessage' => 'Specified instance does not support the data disk category or size.', 'description' => 'The instance to be mounted does not support the disk category or size.'],
['errorCode' => 'InvalidParam.DataDisKSizeInvalid', 'errorMessage' => 'The specified cloud disk size is invalid.', 'description' => 'The size of the disk does not match the type. Please insure the size of the cloud disk is within the supported range.'],
['errorCode' => 'OperationDenied.SnapshotNotSupport', 'errorMessage' => 'The specified snapshot type is shared, which is not supported.', 'description' => 'Use of shared snapshots is not supported'],
['errorCode' => 'OperationDenied.SnapshotNotAvailable', 'errorMessage' => 'The specified snapshot is not available.', 'description' => 'Snapshot not available'],
['errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', 'description' => 'The current disk does not support this operation.'],
['errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', 'description' => 'The specified disk category is not supported by the instance type.'],
['errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', 'description' => 'The instance to which the cloud disk is attached does not support hot swapping of cloud disks.'],
['errorCode' => 'OperationDenied.InstanceDiskLimitExceeded', 'errorMessage' => 'The amount of the disk on instance in question reach its limits.', 'description' => 'The specified instance has reached the maximum number of disks that can be attached.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', 'description' => 'The target Availability Zone does not have enough resources.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateRCDisk',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
],
'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', 'title' => ''],
],
[
'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********', 'title' => ''],
],
[
'name' => 'ImageName',
'in' => 'query',
'schema' => ['description' => 'The name of the custom image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Created_from_rc-vma9w5z699x9********', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'required' => false, 'example' => "\n"
.'rc-vma9w5z699x93204****', 'title' => ''],
],
],
'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*******'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', 'description' => 'Invalid InstanceId, no valid instance data found'],
['errorCode' => 'InvalidParameter.ImageName', 'errorMessage' => 'The image name is null.', 'description' => 'Mirror name not passed in'],
['errorCode' => 'InvalidParameter.DuplicateImageName', 'errorMessage' => 'The image name is duplicated.', 'description' => 'Duplicate Mirror Name'],
],
404 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
],
500 => [
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:CreateRCImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8D78AED-5050-113C-A46E-7B346*******\\"\\n}","type":"json"}]',
],
'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', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'SecurityEnhancementStrategy',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password for the root account of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'DeleteWithInstance' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'title' => ''],
'Encrypted' => ['description' => 'Specifies whether to encrypt the data disk. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
'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', 'title' => ''],
'Size' => ['description' => 'The size of the data disk. Unit: GiB. Valid values: 20 to 65536.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DeploymentSetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ds-uf6c8qerk019bj1l****', 'title' => ''],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'InternetMaxBandwidthOut',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'IoOptimized',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image-dsvjzw2ii8n4fvr6de', 'title' => ''],
],
[
'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', 'title' => ''],
'Size' => ['description' => 'The size of the system disk. Unit: GiB. Valid values: 20 to 2048.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'HostName',
'in' => 'query',
'schema' => ['description' => 'The instance hostname.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testHost1', 'title' => ''],
],
[
'name' => 'SpotStrategy',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'NodePoolName',
'in' => 'query',
'schema' => ['description' => 'The name of the node pool.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testNodePool', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', '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****\']}', 'title' => ''],
'title' => '',
'example' => '',
],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '50357661918****', 'title' => ''],
'NodePoolId' => ['description' => 'The node pool ID.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => 'The instanceType of the specified instance does not support this disk category.'],
['errorCode' => 'InvalidInstanceType.ZoneNotSupported', 'errorMessage' => 'The specified zone does not support this instancetype.', 'description' => 'The specified zone does not support this instancetype.'],
['errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified instance type is not supported.', 'description' => 'The specified instance type is not supported.'],
['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => 'The specified ImageId does not exist.'],
['errorCode' => 'InsufficientCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested resource.', 'description' => 'Insufficient resources. Please try again later.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'InvalidTargetDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The specified database instance name does not exist.'],
['errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', 'description' => ''],
['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.', 'description' => 'The specified DataDisk.n.Size is outside the allowed range, or the capacity of the snapshot exceeds the size limit for the specified disk category.'],
['errorCode' => 'InvalidParameters.SystemSize', 'errorMessage' => 'SystemDisk size is invalid.', 'description' => 'The system disk size is invalid.'],
['errorCode' => 'InvalidHostName.CustomMalformed', 'errorMessage' => 'Customized section of host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].', 'description' => 'The custom part of the hostname is invalid, please use a valid format:[], [,], [m,], [, n], [m, n].'],
['errorCode' => 'InvalidParameter.AckEdgeParam', 'errorMessage' => 'The specified AckEdgeParam is not valid.', 'description' => 'AckEdgeParam parameter error.'],
['errorCode' => 'InvalidParameter.AckMode', 'errorMessage' => 'CreteMode should be 1 and SupportCase should be edge.', 'description' => 'When creating an instance in Ack Edge mode, you need to set the CreteMode to 1 and the SupportCase to edge.'],
['errorCode' => 'InvalidParameter.AutoPay', 'errorMessage' => 'AutoPay should be true.', 'description' => 'The AutoPay should be true.'],
['errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified parameter "Description" is not valid.', 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['errorCode' => 'InvalidDiskSize.NotSupported', 'errorMessage' => 'The specified parameter size is not valid.', 'description' => 'The specified disk capacity is invalid.'],
['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The specified parameter "Password" is not valid.', 'description' => ''],
['errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', 'description' => 'The parameter PerformanceLevel of the specified data disk is invalid.'],
['errorCode' => 'InvalidSystemDiskCategory.ValueNotSupported', 'errorMessage' => 'The current operation does not support this system disk type.', 'description' => 'The current operation does not support this system disk type.'],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'InvalidDataDiskCategory.NotSupported', 'errorMessage' => 'Specified disk category is not supported.', 'description' => ''],
['errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', 'description' => ''],
['errorCode' => 'InvalidDiskCategory.ValueNotSupported', 'errorMessage' => 'Specified disk category is not supported.', 'description' => ''],
['errorCode' => 'InvalidUserData.SizeExceed', 'errorMessage' => 'The UserData is invalid, the size of UserData should not greater than 32KB.', 'description' => 'UserData exceeds limit.'],
['errorCode' => 'InvalidZoneId.DiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support setting the ZoneId.', 'description' => 'The specified disk type does not support setting the Availability Zone.'],
['errorCode' => 'ResourceNotFound.VpcPeer', 'errorMessage' => 'The specified resource of VpcPeer is not found.', 'description' => 'The vpc instance to which the VSwitch belongs in the request parameter has not established a vpc peer-to-peer connection with the resource account.'],
['errorCode' => 'IncorrectStatus.VpcPeer', 'errorMessage' => 'The specified resource of VpcPeer status is invalid.', 'description' => 'The vpc peer-to-peer connection between the vpc instance to which the switch belongs and the resource account is currently not activated.'],
],
403 => [
['errorCode' => 'InvalidSecurityGroupId.NotFound', 'errorMessage' => 'The specified SecurityGroupId does not found.', 'description' => 'The security group that is specified by the SecurityGroupId parameter cannot be found. The security group and the RDS instance do not belong to the same region.'],
['errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified InstanceType is not Supported.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'OperationDenied.SystemConcurrent', 'errorMessage' => 'Failure caused by Concurrent operations.', 'description' => ''],
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Arguments on this idempotent request are inconsistent with arguments used in previous request(s).', 'description' => 'The requested clientToken is duplicated.'],
['errorCode' => 'InstanceDiskNumLimitExceed', 'errorMessage' => 'The number of specified disk in an instance exceeds.', 'description' => ''],
['errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', 'description' => 'The current disk does not support this operation.'],
['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', 'description' => ''],
['errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', 'description' => ''],
['errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', 'description' => ''],
['errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
],
[
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'DeploymentSet.NotFound', 'errorMessage' => 'The specified deployment set does not exist.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateRCNodePool',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'operationType' => 'readAndWrite',
],
'CreateRCSnapshot' => [
'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', 'title' => ''],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcd-wz9f3peueu5npsl****', 'docRequired' => true, 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'This parameter has been deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'InstantAccess',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'InstantAccessRetentionDays',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Tag Details.',
'type' => 'array',
'items' => [
'description' => 'Tag Details.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'tag key.', 'type' => 'string', 'required' => false, 'example' => 'testRC', 'title' => ''],
'Value' => ['description' => 'tag value.', 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rc-t8q22a87745hf8****', 'title' => ''],
],
],
'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****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidRetentionDays.Malformed', 'errorMessage' => 'The specified RetentionDays is not valid.', 'description' => 'The specified retention days are invalid. Check whether the RetentionDays parameter values are correct.'],
['errorCode' => 'InvalidOperation.Conflict', 'errorMessage' => 'ecs task is conflicted.', 'description' => 'The ECS task corresponding to the Custom instance conflicts. Please try again later.'],
['errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', 'description' => 'Elastic temporary disks do not support snapshot recovery or snapshot creation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', 'description' => ''],
['errorCode' => 'CreateSnapshot.Failed', 'errorMessage' => 'The process of creating rc snapshot is failed.', 'description' => 'Snapshot creation failed.'],
['errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', 'description' => 'The current disk does not support this operation.'],
['errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
['errorCode' => 'QuotaExceed.Snapshot', 'errorMessage' => 'The snapshot quota exceeds.', 'description' => 'The snapshot quota exceeds the limit. If you want to store new snapshots, delete the existing old snapshots without affecting your business.'],
['errorCode' => 'IncorrectDiskStatus.NeverAttached', 'errorMessage' => 'The specified disk has never been attached to any instance.', 'description' => ''],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create Snapshot',
'summary' => 'Create a snapshot for a disk.',
'description' => 'You cannot create a snapshot for the specified disk in the following scenarios:'."\n"
.'- The number of retained manual snapshots for the disk has reached 256.'."\n"
.'- The previous snapshot creation has not completed.'."\n"
.'- The instance to which the disk is mounted has never been started.'."\n"
.'- The instance to which the disk is mounted is not in the **Stopped** or **running** state.'."\n"
."\n"
.'When creating a snapshot, note the following:'."\n"
."\n"
.'- If snapshot creation has not completed, the snapshot cannot be used to create a custom image (CreateImage).'."\n"
.'- If the disk is attached to an RDS Custom instance, do not change the instance status during snapshot creation.'."\n"
.'- You can create snapshots for disks in the **expired** state. If the disk reaches its expiration and release time while a snapshot is being created, the disk will be released and the snapshot in the **Creating** state will be deleted simultaneously.',
'changeSet' => [
['createdAt' => '2025-05-07T03:00:42.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRCSnapshot'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateRCSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE93CC0D-B65D-5723-AAB1-08CB8BBABAB9\\",\\n \\"SnapshotId\\": \\"rcds-7mbefjzkqccvdev****\\"\\n}","type":"json"}]',
],
'CreateReadOnlyDBInstance' => [
'summary' => 'This API is used to create a read-only instance for an RDS 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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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' => 'mysqlro.n2.small.1c', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testReadOnly', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'GdnInstanceName',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TddlBizType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'TddlRegionConfig',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'InstructionSetArch',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['description' => 'An invalid parameter. You do not need to specify this parameter.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'IsAnalyticReadOnlyIns',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to create a DuckDB analytic instance. Valid values:'."\n"
."\n"
.'- **true**: Enabled'."\n"
.'- **false**: Disabled'."\n"
."\n"
.'> Currently, only RDS MySQL and RDS PostgreSQL support creating DuckDB analytic instances.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '71744626****', 'title' => ''],
],
[
'name' => 'CustomExtraInfo',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. No configuration is required. ', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the read-only instance.'."\n", 'type' => 'string', 'example' => 'rr-uf6wjk5****', 'title' => ''],
'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '10078937****', 'title' => ''],
'Port' => ['description' => 'The internal port number that is used to connect to the read-only instance.'."\n", 'type' => 'string', 'example' => '3306', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The specified parameter EngineVersion is not valid.', 'description' => ''],
['errorCode' => 'InvalidNetworkTypeClassicWhenCloudStorage', 'errorMessage' => 'The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.', 'description' => 'When selecting a cloud storage type, specifying a InstanceNetworkType value of Classic is not valid.'],
['errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter SecurityIPList is not valid.', 'description' => ''],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', 'description' => 'The IP address is invalid. Specify a valid IP address.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter dbInstanceId is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied', 'errorMessage' => 'VPC IP is in use, please check.', 'description' => 'The operation failed. The VPC IP address has been used.'],
['errorCode' => 'InvalidZoneId.NotSupported', 'errorMessage' => 'The Specified vpc Zone not supported.', 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.'],
['errorCode' => 'InvalidAvZone.NotSupport', 'errorMessage' => 'Specified availableArea multiZone does not support in RDS.', 'description' => ''],
['errorCode' => 'CDDC.AvailableHostsNotEnoughInZone', 'errorMessage' => 'Not enough available hosts are in the target zone.', 'description' => ''],
['errorCode' => 'InvalidReadEngineVersionPattern', 'errorMessage' => 'The engine versions of the primary instance and the read-only instance do not match.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'SYSTEM.CONCURRENT_OPERATE', 'errorMessage' => 'Concurrent operation is detected.', 'description' => 'Concurrent operations are run in the system.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'InvalidDBInstanceName.Duplicate', 'errorMessage' => 'Specified DB instance name already exists in the Aliyun RDS.', 'description' => 'The operation failed. The instance name already exists. Specify a different name and try again.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', 'description' => 'The request is copy, check your token.'],
['errorCode' => 'InvalidParam.InstanceNetworkType', 'errorMessage' => 'Creation of classic network instances is not supported.', 'description' => 'Classic network offline, does not support the creation of classic network instances!'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => '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.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => ''],
['errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', 'description' => 'The value of the parameter is invalid.'],
['errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', 'description' => 'The master switch requires at least 3 available IPs.'],
['errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', 'description' => 'The master switch requires at least 2 available IPs.'],
['errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', 'description' => 'The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.'],
],
403 => [
['errorCode' => 'OperationDenied.PrimaryDBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of primary instance.', 'description' => 'The operation failed. The RDS instance is deployed in a dedicated cluster and is not running.'],
['errorCode' => 'InvalidReadStorageTypePattern', 'errorMessage' => 'The storage type of the primary instance and the read-only instance do not match.', 'description' => ''],
['errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance character type does not support this operation.', 'description' => 'This operation is not supported for the character type of the instance.'],
['errorCode' => 'InvalidMultiparamZoneInfoList', 'errorMessage' => 'Zoneinfo list is invaild.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'BasicCategoryNotSupport', 'errorMessage' => 'The Basic category is not supported.', 'description' => 'Basic series not supported'],
],
[
['errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', 'description' => ''],
['errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', 'description' => ''],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Create a Read-Only Instance ',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
."\n"
.'### Related Function Documentation'."\n"
.'>Before using this API, carefully read the Function Documentation to fully understand the prerequisites and potential impacts of using this API before proceeding with any operation.>'."\n"
."\n"
.'- [Create a Read-Only Instance for RDS MySQL](~~56991~~)'."\n"
.'- [Create a DuckDB Analytic Instance for RDS MySQL](~~2950002~~)'."\n"
.'- [Create a Read-Only Instance for RDS PostgreSQL](~~108959~~)'."\n"
.'- [Create a DuckDB Analytic Instance for RDS PostgreSQL](~~2977241~~)'."\n"
.'- [Create a Read-Only Instance for RDS SQL Server](~~99005~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-11-19T13:27:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-14T13:06:06.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-12T14:41:15.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-01T04:41:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-27T13:13:45.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-13T13:26:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-23T14:34:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-05-28T06:58:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-23T09:42:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-18T06:44:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-04T11:54:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-23T07:45:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T09:20:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-07T05:52:27.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-11T02:54:52.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-08-10T02:02:25.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-01T16:23:49.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-04-20T06:35:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-07T08:52:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-09-13T12:23:22.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReadOnlyDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateReadOnlyDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'rm-2zeytekus0r******'."\n", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'PostgreSQL:pgm-****.pg.rds.aliyuncs.com'."\n"
.'SQL Server:10.XX.XXX.XXX', 'title' => ''],
],
[
'name' => 'SourcePort',
'in' => 'query',
'schema' => ['description' => 'The port of the source instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '5432', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ReplicatorPassword',
'in' => 'query',
'schema' => ['description' => 'The password of the account.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testpassword', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID of the successful dry run.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '43994****', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'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' => 'rm-2zeaaz62s18******', 'title' => ''],
],
[
'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' => 'zbtest', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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' => 'PostgreSQL:pgm-****.pg.rds.aliyuncs.com'."\n"
.'SQL Server:92****', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '442FC501-C4DD-1349-B70A-DE13D189072E'],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '159****', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'zbtest', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidTaskId.Format', 'errorMessage' => 'The parameter TaskId is required.', 'description' => 'The parameter TaskId is required.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'ENDPOINT_NOT_FOUND', 'errorMessage' => 'The source address %s must be the endpoint of source instance %s.', 'description' => 'Illegal source instance address'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-03-19T01:33:46.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-02-28T09:13:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-19T03:02:13.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReplicationLink'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateReplicationLink',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['description' => 'The username that is used to access the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_jack', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password that is used to access the database.'."\n", 'type' => 'string', 'required' => true, 'example' => '12345678', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'users', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the credential.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Foo', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The engine of the database.'."\n"
."\n"
.'> Only MySQL is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''],
],
],
'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****', 'title' => ''],
'SecretName' => ['description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-01-22T10:07:22.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-24T02:51:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-01T15:16:43.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSecret'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'rds:CreateSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Caller.NotSupport', 'errorMessage' => 'The Caller Not Support This Operation .', 'description' => 'This operation is not supported for the caller.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2021-12-23T13:28:38.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateServiceLinkedRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B4CAF581-2AC7-41AD-8940-D56DF7AA****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B4CAF581-2AC7-41AD-8940-D56DF7AA****\\n","errorExample":""}]',
],
'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-bp13****', 'title' => ''],
],
[
'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' => '1883****', 'title' => ''],
],
[
'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' => '2023-06-11T16:00:00Z', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '069EB9B1-DE12-54B9-8C20-822****', 'title' => ''],
'TempDBInstanceId' => ['description' => 'The temporary instance ID.'."\n", 'type' => 'string', 'example' => 'sub16****_rm-bp13****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', 'description' => ''],
['errorCode' => 'IncorrectInstanceNetworkType', 'errorMessage' => 'The specified parameter InstanceNetworkType is not valid.', 'description' => ''],
['errorCode' => 'InvalidAvailableArea.NotFound', 'errorMessage' => 'Specified available area does not exist in RDS.', 'description' => ''],
['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', 'description' => 'The parameter type is invalid.'],
['errorCode' => 'InvalidRetainInstance.Format', 'errorMessage' => 'Specified retain instance is not valid.', 'description' => 'The value of the RestoreTime parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidInstanceLevelExtraInfo', 'errorMessage' => 'Specified class code has error extra info.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.TempDBInstanceExists', 'errorMessage' => 'The operation is not permitted due to temp instance exist.', 'description' => 'The operation failed. A temporary RDS instance has been created for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', 'description' => 'The read-only instance already exists.'],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', 'description' => 'The operation failed. The data backup file does not support the restoration of individual databases and tables.'],
['errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', 'description' => 'The operation failed. The data backup file is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceConnType', 'errorMessage' => 'Current DB instance conn type does not support this operation.', 'description' => 'The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified db instance is not found.', 'description' => 'The operation failed. The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-04-30T15:02:06.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-02T13:21:44.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateTempDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTempDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'CreateYouhuiForOrder' => [
'summary' => 'This API is used to claim a coupon.',
'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' => '171151088708****', 'title' => ''],
],
[
'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' => '200000199****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0688F1D2-CDA8-5617-A43C-ADAC61D80D43', 'title' => ''],
'YouhuiId' => ['description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => '22120151****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'YouhuiClientError', 'errorMessage' => 'Calling service from youhui service error', 'description' => ''],
['errorCode' => 'CouponExist', 'errorMessage' => 'Voucher collection has reached the upper limit, and the system has recalculated the optimal price.', 'description' => 'You have reached the maximum number of coupons. The price is being recalculated.'],
['errorCode' => 'YouhuiServerError', 'errorMessage' => 'Calling service from youhui service errror', 'description' => ''],
['errorCode' => 'CreateCouponError', 'errorMessage' => 'Failed to collect the coupon and place the order. The system has recalculated the optimal price.', 'description' => ''],
['errorCode' => 'CouponOverMaxRelease', 'errorMessage' => 'The coupons have been collected and the system has recalculated the optimal price.', 'description' => ''],
['errorCode' => 'MissingActivityId', 'errorMessage' => 'ActivityId is mandatory for this action.', 'description' => 'ActivityId is mandatory for this action.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ParamError', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'ActivityNotFound', 'errorMessage' => 'The activity does not exist.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0688F1D2-CDA8-5617-A43C-ADAC61D80D43\\",\\n \\"YouhuiId\\": \\"22120151****\\"\\n}","type":"json"}]',
'title' => 'Claim Coupon',
'changeSet' => [
['createdAt' => '2024-06-04T06:14:30.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateYouhuiForOrder'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:CreateYouhuiForOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', 'description' => 'Instance cloning is not supported for the database engine version of the current instance.'],
['errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', 'description' => ''],
['errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType is not support operation.', 'description' => 'This operation is not supported for the specified instance type.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current DB instance engine version does not support this operation.', 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['errorCode' => 'InvalidADDNS.NotFound', 'errorMessage' => 'Specified ADDNS is null.', 'description' => 'Specified ADDNS is null.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', 'description' => 'The Custins cluster type is invalid. Only the user cluster type is supported.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-05-22T06:50:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-01-11T06:42:43.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteADSetting'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteADSetting',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DeleteAccount' => [
'summary' => 'Deletes an account from an instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'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****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => ''],
['errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', 'description' => ''],
['errorCode' => 'Account.DeleteError', 'errorMessage' => 'Failed to delete the account. Parameter values are invalid, or the request is waiting for locks.', 'description' => ''],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal 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).', 'description' => '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.', 'description' => 'Database objects depend on the account that is used to perform this operation. Remove the dependency and perform this operation again.'],
['errorCode' => 'Account.SupabaseAdminRestricted', 'errorMessage' => 'This account is managed by Supabase and is restricted from direct modification. Please use the Supabase Console or API.', 'description' => 'This account is managed by the Supabase and cannot be modified directly. Use the RDS Supabase console or API to modify.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-05-12T02:14:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-31T08:25:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-05T05:19:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-06T03:22:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-09-30T09:27:02.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'operationType' => 'readAndWrite',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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' => '32490****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => ''],
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', 'description' => 'You must enter at least one selectable parameter.'],
['errorCode' => 'DeleteBackupSetNumExceed', 'errorMessage' => 'Delete backup set number is more than 100.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'OperationDenied.BackupSetDeleteNotSupport', 'errorMessage' => 'The Specified backup does not support this operation.', 'description' => 'The current backup set cannot be deleted.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteBackup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
],
[
'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' => '2024-06-11T16:00:00Z', 'title' => ''],
],
],
'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****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C7B3A91C-0ACD-4948-ACAE-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-11T10:20:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-23T07:45:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-27T04:15:25.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackupFile'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteBackupFile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when the instance is being migrated across engines.'],
['errorCode' => 'OperationDenied.DeletionProtection', 'errorMessage' => 'The operation is not permitted when the instance enabled deletion protection.', 'description' => 'Instances cannot be deleted if deletion protection is enabled.'],
['errorCode' => 'GuardInstance.ReleaseFail', 'errorMessage' => 'The guard instance release fail.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'master instance not exist.', 'description' => 'The primary instance data does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'BackupPropertyNotFound', 'errorMessage' => 'Backup policy not found', 'description' => 'The operation failed. The backup policy cannot be found.'],
],
403 => [
['errorCode' => 'OperationDenied.PrePayTypeNotSupported', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', 'description' => 'Subscription instances cannot be directly deleted.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T12:45:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-26T03:06:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-16T04:02:18.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-18T03:26:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:10.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-17T08:37:48.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2021-12-17T08:37:48.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'EndpointType.NotSupport', 'errorMessage' => 'Current db type is not support specified endpoint type.', 'description' => 'The specified endpoint type is invalid.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceEndpoint'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBInstanceEndpoint',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', 'title' => ''],
],
'enumValueTitles' => [],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'InvalidNetType.Format', 'errorMessage' => 'Specified NetType is not valid.', 'description' => 'The value of the NetType parameter is invalid.'],
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-05-09T12:13:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBInstanceEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DeleteDBInstanceReplication' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', '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.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance list.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1234567890abcdef', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'ChannelName',
'in' => 'query',
'schema' => ['description' => 'The name of the replication channel to delete.', 'type' => 'string', 'required' => false, 'example' => 'replication-channel-001', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidReplicationChannelName.Forbid', 'errorMessage' => 'Specified replication channel name is forbidden (reserved for internal use).', 'description' => 'Specified replication channel name is forbidden (reserved for internal use).'],
],
404 => [
['errorCode' => 'InvalidReplicationChannel.NotFound', 'errorMessage' => 'Specified replication channel does not exist.', 'description' => 'Specified replication channel does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete replication channel ',
'summary' => 'Deletes a replication channel from a native replication instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","type":"json"}]',
],
'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******', 'title' => ''],
],
[
'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******', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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******', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'Message' => ['description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F8'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceSecurityGroupRule'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBInstanceSecurityGroupRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
'required' => true,
'maxItems' => 7,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100780000000000', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8B993DA9-5272-5414-94E3-4CA8BA0146C2'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'DBNodeIdParameterInvalid', 'errorMessage' => 'The specified parameter DBNodeId is malformed.', 'description' => 'The specified DBNodeId parameter is invalid.'],
['errorCode' => 'DBNodeIdParameterNotFound', 'errorMessage' => 'The specified parameter DBNodeId is required.', 'description' => 'You must specify the DBNodeId parameter.'],
['errorCode' => 'DBNodeParameter.TooFewItems', 'errorMessage' => 'The specified parameter DBNode has too few items.', 'description' => 'A small number of DBNode parameter items are configured.'],
['errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', 'description' => 'The ClassCode configuration is invalid for the DBNode parameter.'],
['errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The DBNodeId in the parameter does not exist.', 'description' => 'The DBNodeId in the parameter does not exist.'],
['errorCode' => 'DBNodeIdParameter.IncludePrimary', 'errorMessage' => 'The specified parameter DBNodeId include primary node.', 'description' => 'The parameter DBNodeId passed in contains the master node.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-11-13T02:31:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-08T11:34:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-07T09:25:22.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2023-07-21T09:58:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-12-16T05:31:13.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBNodes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'Specified vpc instance id is not valid.', 'description' => 'The specified VPC ID is invalid.'],
['errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'Current DB instance net type does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'AtLeastOneNetTypeExists', 'errorMessage' => 'The current database instance network type does not support the operation', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['errorCode' => 'InvalidDBInstanceNetType.NotFound', 'errorMessage' => 'Specified DB instance net type is not found.', 'description' => 'The operation failed. The network type of the RDS instance is invalid. Specify a valid network type.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-12-19T11:02:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:56:18.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBProxyEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDBProxyEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testdb01', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidDBName.Forbid', 'errorMessage' => 'Specified DB name is a keyword in RDS.', 'description' => 'Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.'],
['errorCode' => 'Database.DelError', 'errorMessage' => 'Failed to delete the database. Check the specified parameters and the instance state.', 'description' => 'Failed to delete the database. Check the specified parameters and the instance status.'],
['errorCode' => 'ColdDBHasSameNameWithOnlineDB', 'errorMessage' => 'The instance has cold db and online db with the same name.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', 'description' => 'The operation failed. The account mode of the current instance does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'IncorrectDBState', 'errorMessage' => 'The current DB state does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state. For example, the RDS instance is being created or is receiving data from a migration task.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', 'description' => 'The operation failed. The instance name cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-02T02:33:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T11:37:30.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteDatabase',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatabase'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-14T03:57:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-19T15:04:16.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGadInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteGadInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'GadInstance', 'arn' => 'acs:rds::{#accountId}:gadinstance/{#GadInstanceName}'],
],
],
],
],
],
'DeleteMaskingRules' => [
'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' => 'The name of the rule to delete.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response payload.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The result of the operation.',
'additionalProperties' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-t4n8t18o******6d5'."\n", 'title' => ''],
'type' => 'object',
'title' => '',
'example' => '',
],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5EEE1ED1-A459-38D2-840C-0C49********'],
'Success' => ['description' => 'Whether the operation succeeded.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', 'description' => 'The parameter does not exist. Check parameter configurations.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete an encryption or desensitization rule',
'summary' => 'Deletes the encryption or data desensitization rules for the specified instance.',
'description' => '## Request'."\n"
."\n"
.'- Before calling this API, ensure that the column encryption service is enabled in the DAS Security Center.'."\n"
."\n"
.'- If you receive the `ColumnEncryptionErrorCode.NOT_PURCHASED` error message, go to the DAS Security Center to purchase and enable the column encryption service, then try again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteMaskingRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8AF26036-B254-4212-B8E4-EFBE818B7FD6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', 'description' => 'The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.'],
['errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', 'description' => 'The paramGroups does not exist or its type is not supported.'],
['errorCode' => 'ParamGroupsInUse', 'errorMessage' => 'Delete an in-use param group is forbidden.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-14T01:37:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteParameterGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParameterGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'DeleteParameterTimedScheduleTask' => [
'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' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The ID of the scheduled parameter modification task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '41698', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'ScheduleTask.NotFound', 'errorMessage' => 'Parameter modification timed task not found.', 'description' => ''],
['errorCode' => 'ScheduleTask.OperationFailed', 'errorMessage' => 'Parameter modification timed task operation failed.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete a Scheduled Task for Parameter Modification',
'summary' => 'Deletes a scheduled task for modifying instance parameters.',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before calling this operation, read the related documentation to understand its prerequisites and impacts.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Set parameters for an RDS MySQL instance](~~96063~~)'."\n"
."\n"
.'- [Set parameters for an RDS PostgreSQL instance]()',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:DeleteParameterTimedScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\"\\n}","type":"json"}]',
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePostgresExtensions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeletePostgresExtensions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'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****', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteRCClusterNodes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCClusterNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteRCClusterNodes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0970A1-0434-5C83-B560-613EBA11B525\\",\\n \\"TaskId\\": \\"238028563\\"\\n}","type":"json"}]',
],
'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', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'DeploymentSetId',
'in' => 'query',
'schema' => ['description' => 'The deployment set ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ds-uf6c8qerk019bj1l****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DependencyViolation.NotEmpty', 'errorMessage' => 'There are still instance(s) in the specified DeploymentSetId.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'SDK.InvalidRegionId', 'errorMessage' => 'Can not find endpoint to access.', 'description' => 'Cannot find endpoint to access.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","type":"json"}]',
'title' => 'DeleteRCDeploymentSet',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:DeleteRCDeploymentSet',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'CustomDeploymentSet', 'arn' => 'acs:rds:{#regionId}:{#accountId}:customdeploymentset/{#CustomDeploymentSetId}'],
],
],
],
],
'operationType' => 'read',
],
'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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', 'description' => ''],
['errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
['errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', 'description' => ''],
['errorCode' => 'OperationDenied.DiskTypeViolation', 'errorMessage' => 'The specified disk is a system disk and cannot support the operation.', 'description' => 'The specified cloud disk is a system disk and cannot be uninstalled.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-05-07T03:00:42.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCDisk'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteRCDisk',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'CustomDisk', 'arn' => 'acs:rds:{#regionId}:{#accountId}:customdisk/{#DiskId}'],
],
],
],
],
],
'DeleteRCInstances' => [
'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', 'title' => ''],
],
[
'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' => 'rc-lrt4wdv22tr180f7****', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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' => 'None', 'title' => ''],
],
[
'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' => 'false', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', 'description' => 'Invalid InstanceId, no valid instance data found'],
['errorCode' => 'CallRdsCustomApi.Failure', 'errorMessage' => 'Failed to call rds custom api.', 'description' => 'Failed to call RDS-Custom Api'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'RemainRefundOrderFail', 'errorMessage' => 'Reamin refund order for instance fail.', 'description' => 'Instance refund failed.'],
['errorCode' => 'InvalidOperation.DeletionProtection', 'errorMessage' => '%s.', 'description' => 'This operation is invalid. Cancel the release protection of the instance first.'],
['errorCode' => 'InvalidOperation.NodeStatusNotSupported', 'errorMessage' => 'Please delete the pods on the vNode before deleting the vNode.', 'description' => '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.', 'description' => 'The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The specified instance does not exist or is not supported.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteRCInstances',
'summary' => 'Releases a subscription RDS Custom instance.',
'description' => 'After an instance is released, all physical resources used by the instance are recycled. Relevant data is erased and cannot be restored.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteRCInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\"\\n}","type":"json"}]',
],
'DeleteRCSnapshot' => [
'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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteRCSnapshot',
'summary' => 'Deletes a cloud disk snapshot.',
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCSnapshot'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteRCSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BE834C8-3C25-5AF8-BE3E-C8A690602A7F\\"\\n}","type":"json"}]',
],
'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' => 'm-2zecuz9tolf******', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the DR instance.'."\n", 'type' => 'string', 'example' => 'PostgreSQL:pgm-bp1trqb4p1******'."\n"
.'SQL Server:135****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1EFCFB59-7152-19C4-8C53-F887D107AFD3', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '159****', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'zbtest', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => '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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteReplicationLink',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteReplicationLink'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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*****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The engine of the database.'."\n"
."\n"
.'> Only MySQL is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'SecretName' => ['description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'SecretNotFound', 'errorMessage' => 'Specified rds data api secret is not found', 'description' => 'The DataAPI credential is not found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-24T02:51:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-01T15:16:43.000Z', 'description' => 'OpenAPI offline'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecret'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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****', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'Specified Status is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-04-10T08:27:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSlot'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteSlot',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F28AE40B-203B-4CFE-B81F-FD981CD97B17', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', 'description' => 'The product code is not supported.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DeleteUserBackupFile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserBackupFile'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'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' => 'ETnLKlblzczshOTUbOCz*******', 'title' => ''],
],
[
'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-bp*****', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database engine of the instance. Set the value to **MySQL**'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''],
],
[
'name' => 'ImportId',
'in' => 'query',
'schema' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123', 'title' => ''],
],
[
'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' => '2023-06-11T15:00Z', 'title' => ''],
],
[
'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' => '2023-06-11T16:00Z', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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*****', 'title' => ''],
],
],
'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', 'title' => ''],
'ImportDataStatusDescription' => ['description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => '描述信息。', 'title' => ''],
'ImportDataType' => ['description' => 'The type of the migration task. Valid values:'."\n"
."\n"
.'* **Full**: full migration'."\n"
.'* **Incremental:**: incremental migration'."\n", 'type' => 'string', 'example' => 'Full', 'title' => ''],
'ImportId' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''],
'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' => '2023-06-11T15:00Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B000AA91-393D-46F9-8D9B-098E28931A3A', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidMigrationType.Format', 'errorMessage' => 'Specified migration type is not valid.', 'description' => ''],
['errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', 'description' => 'The page number cannot be found.'],
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', 'description' => 'You must enter at least one selectable parameter.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', 'description' => ''],
['errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","errorExample":""}]',
'title' => 'DescibeImportsFromDatabase',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:07.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescibeImportsFromDatabase'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescibeImportsFromDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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', 'title' => ''],
'ADServerIpAddress' => ['description' => 'The service IP address of the AD domain.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
'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', 'title' => ''],
'AbnormalReason' => ['description' => 'The cause of the error.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'UserName' => ['description' => 'The username of the AD domain.'."\n", 'type' => 'string', 'example' => 'test_01', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-06-13T11:58:34.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeADInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeADInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
],
'DescribeAccountMaskingPrivilege' => [
'summary' => 'Retrieves the encryption or data masking permission configuration for 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', 'title' => ''],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => ['description' => 'The name of the account. You can specify an account to query.', 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'UserPrivilege' => [
'description' => 'A list of user privileges for encryption or data masking.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ExpireTime' => ['description' => 'The expiration time of the privilege, in UTC.', 'type' => 'string', 'example' => '2026-01-22T02:01:20Z', 'title' => ''],
'Privilege' => ['description' => 'The privilege type. A value of `restrictedAccess` indicates that data masking is enabled for the user.', 'type' => 'string', 'example' => 'restrictedAccess', 'title' => ''],
'UserName' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'rds', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0073A98-52F1-3075-8256-394**********'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query account encryption or data masking permissions',
'description' => '## Usage notes'."\n"
."\n"
.'- Enable the column encryption service in the DAS Security Center before you call this API.'."\n"
."\n"
.'- If you receive the ColumnEncryptionErrorCode.NOT\\_PURCHASED error, go to the DAS Security Center, purchase and enable the column encryption service, and then call the API again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeAccountMaskingPrivilege',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'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"}]',
],
'DescribeAccounts' => [
'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-bp1v6z81ho9******', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the database account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zhttest', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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' => '测试数据库账号', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the instance to which the account belongs.'."\n", 'type' => 'string', 'example' => 'rm-bp1v6z81ho9******', 'title' => ''],
'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', 'title' => ''],
'AccountPrivilegeDetail' => ['description' => 'The permissions that are granted to the account. For more information, see [Account permissions](~~146395~~).'."\n", 'type' => 'string', 'example' => 'SELECT,INSERT', 'title' => ''],
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'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', 'title' => ''],
'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'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '17F2EA6C-3CA2-528D-A263-DC29707AD652', 'title' => ''],
'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' => '2023-10-17T07:51:22Z', 'title' => ''],
'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', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to query account list.', 'description' => ''],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'Account.QueryError', 'errorMessage' => 'Query Account failed, please check your input value.', 'description' => 'Failed to query the account, check the request parameters. For example, check whether the specified account of the RDS for MySQL instance contains special characters.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is already open and can only have one user at a time.', 'description' => ''],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeAccounts',
'summary' => 'Queries the details about the accounts that are created on an ApsaraDB RDS instance.',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* RDS MySQL'."\n"
.'* RDS PostgreSQL'."\n"
.'* RDS SQL Server'."\n"
.'* RDS MariaDB'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-14T08:05:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-11-14T06:42:24.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-09-26T10:22:34.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-09T13:00:17.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-06-03T09:07:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T02:27:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-15T12:25:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-15T12:25:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-08T02:07:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAccounts',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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', 'title' => ''],
],
[
'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*****', 'title' => ''],
],
],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region does not support.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', 'description' => ''],
['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified user is not found. Please check again.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:07.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActionEventPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeActionEventPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeActiveOperationMaintainConf' => [
'summary' => 'Obtain the user\'s O\\\\&M configuration information, which currently includes scheduled management event time window information.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => 'Returned data',
'type' => 'object',
'properties' => [
'Config' => [
'description' => 'Configuration Information',
'type' => 'object',
'properties' => [
'CreatedTime' => ['description' => 'Creation Time, formatted as YYYY-MM-DDTHH:mm:ssZ', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', 'title' => ''],
'CycleTime' => ['description' => 'Cycle time, with multiple values concatenated by English commas'."\n"
."\n"
.'- When cycleType is Week, values 1–7 represent Monday–Sunday'."\n"
."\n"
.'- When cycleType is Month, values 1–28 are allowed', 'type' => 'string', 'example' => '1', 'title' => ''],
'CycleType' => ['description' => 'Cycle type, either Month or Week', 'type' => 'string', 'example' => 'Week', 'title' => ''],
'MaintainEndTime' => ['description' => 'End time of the O\\&M time window, in UTC
'."\n"
.'Default: 20:00:00Z', 'type' => 'string', 'example' => '20:00:00Z', 'title' => ''],
'MaintainStartTime' => ['description' => 'Start time of the O\\&M time window, in UTC
'."\n"
.'Default: 18:00:00Z', 'type' => 'string', 'example' => '18:00:00Z', 'title' => ''],
'ModifiedTime' => ['description' => 'Updated At, formatted as YYYY-MM-DDTHH:mm:ssZ, for example, 2018-05-30T14:30:00Z', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', 'title' => ''],
'Status' => ['description' => 'Whether it is effective'."\n"
."\n"
.'- 1: Valid'."\n"
."\n"
.'- 2: Invalid', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HasConfig' => ['description' => 'Whether a configuration has been set; for the first access, hasConfig is 0'."\n"
."\n"
.'- 1: Yes'."\n"
."\n"
.'- 0: No', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '4438AC3E-ABE3-5943-9436-***********', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query proactive O\\&M configuration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeActiveOperationMaintainConf',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeActiveOperationTasks' => [
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ChangeLevelEn' => ['description' => 'The level of the task in English.'."\n", 'type' => 'string', 'example' => 'System maintenance', 'title' => ''],
'ChangeLevelZh' => ['description' => 'The level of the task in Chinese.'."\n", 'type' => 'string', 'example' => '系统运维', 'title' => ''],
'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', 'title' => ''],
'CurrentAVZ' => ['description' => 'The current zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''],
'DbType' => ['description' => 'The type of the database. Valid values: mysql, pgsql, and mssql.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'DbVersion' => ['description' => 'The minor engine version.'."\n", 'type' => 'string', 'example' => '5.7', 'title' => ''],
'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', 'title' => ''],
'Id' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11111', 'title' => ''],
'Impact' => ['description' => 'The impact of the task.'."\n", 'type' => 'string', 'example' => 'TransientDisconnection', 'title' => ''],
'ImpactEn' => ['description' => 'The impact of the task in English.'."\n", 'type' => 'string', 'example' => 'Transient instance disconnection', 'title' => ''],
'ImpactZh' => ['description' => 'The impact of the task in Chinese.'."\n", 'type' => 'string', 'example' => '实例闪断。', 'title' => ''],
'InsComment' => ['description' => 'The alias and description of the instance.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'InsName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-wz96h8jujh512****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Region' => ['description' => 'The region ID of the pending task.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'ResultInfo' => ['description' => 'The information about the execution result.'."\n", 'type' => 'string', 'example' => 'userCancel', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SubInsNames' => [
'description' => 'The subtasks of the instance.'."\n",
'type' => 'array',
'items' => ['description' => 'The name of the subtask.'."\n", 'type' => 'string', 'example' => 'sub1369716295573-tes2cy6****.2013052818****', 'title' => ''],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'TaskParams' => ['description' => 'The task parameters.'."\n", 'type' => 'string', 'example' => '{'."\n"
.' "Action": "UpgradeDBInstance"'."\n"
.'}', 'title' => ''],
'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', 'title' => ''],
'TaskTypeEn' => ['description' => 'The reason for the task in English.'."\n", 'type' => 'string', 'example' => 'Minor version update', 'title' => ''],
'TaskTypeZh' => ['description' => 'The reason for the task in Chinese.'."\n", 'type' => 'string', 'example' => '小版本升级', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 25.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81****', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidPageParam.Format', 'errorMessage' => 'Page param should be a positive integer.', 'description' => ''],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'InvalidDBType', 'errorMessage' => 'The DB type does not support this operation.', 'description' => 'The DB type does not support this operation.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeActiveOperationTasks',
'summary' => 'Queries the details about scheduled O\\\\\\\\\\\\\\\\\\\\&M tasks for an instance.',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n"
.'* MariaDB'."\n",
'changeSet' => [
['createdAt' => '2024-05-23T09:42:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-13T03:20:23.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeActiveOperationTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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',
'title' => '',
],
],
[
'name' => 'PageNumbers',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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-acfmyhigx******', 'title' => ''],
],
],
'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',
'title' => '',
],
'Data' => [
'description' => 'The data returned.'."\n",
'type' => 'object',
'properties' => [
'CurrPageNumbers' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'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',
'title' => '',
],
'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',
'title' => '',
],
'MaxRecordsPerPage' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'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', 'title' => ''],
'Ips' => ['description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '12.2.X.X,10.0.X.X', 'title' => ''],
'TemplateId' => ['description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', 'title' => ''],
'TemplateName' => ['description' => 'The name of the whitelist template.'."\n", 'type' => 'string', 'example' => 'template_123', 'title' => ''],
'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '168****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalPageNumbers' => ['description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'TotalRecords' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '402', 'title' => ''],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterPaging', 'errorMessage' => 'The parameter maxRecordsPerPage or PageNumbers is invalid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:16:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAllWhitelistTemplate'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAllWhitelistTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '77862BFF-ED59-552A-A2E8-692FEAFC9527', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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~~)',
'changeSet' => [
['createdAt' => '2022-06-13T11:58:34.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAnalyticdbByPrimaryDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAnalyticdbByPrimaryDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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-j', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => ['description' => 'The type of order. Set the value to **BUY**'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'BUY', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'MinValue' => ['description' => 'The minimum storage capacity that is supported for the instance. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', 'description' => 'No relevant constraints are found.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DBInstanceName not found', 'description' => ''],
['errorCode' => 'InvalidCondition.NotFound', 'errorMessage' => 'No class found', 'description' => 'The operation failed. The condition of the available class is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-03-14T13:10:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-30T01:56:55.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableClasses'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAvailableClasses',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
],
'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"', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '39265F46-EC77-4036-8AC4-F035F32F6BE2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAvailableCrossRegion',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1****', 'title' => ''],
'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' => 'sys cpu使用率,sys cpu使用量 / cpu总量', 'title' => ''],
'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', 'title' => ''],
'GroupKey' => ['description' => 'The key of the group to which the Enhanced Monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage', 'title' => ''],
'GroupKeyType' => ['description' => 'The name of the group to which the Enhanced Monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'CPU使用率', 'title' => ''],
'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', 'title' => ''],
'MetricsKey' => ['description' => 'The key of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys.avg', 'title' => ''],
'MetricsKeyAlias' => ['description' => 'The alias of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => 'cpu_sys_per_core', 'title' => ''],
'SortRule' => ['description' => 'The serial number of the Enhanced Monitoring metric.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Unit' => ['description' => 'The unit of the Enhanced Monitoring metric.'."\n", 'type' => 'string', 'example' => '%', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5CD61041-35F7-10F7-BE94-33A48B221218', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of enhanced monitoring metrics that are available for the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableMetrics'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAvailableMetrics',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => '12493****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-chengdu', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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' => '1249****', 'title' => ''],
'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' => '2024-03-04T21:00:47Z', 'title' => ''],
'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' => '2024-03-07T02:23:26Z', 'title' => ''],
'RegionId' => ['description' => 'The region where the source instance resides.'."\n", 'type' => 'string', 'example' => 'cn-chengdu', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8CCBF4BA-7CE1-47E1-B49F-E97EA200A40D', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NoAvailableLogBackup', 'errorMessage' => 'No available log backup.', 'description' => 'No available log backup is found.'],
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', 'description' => 'No available restore set is found.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableRecoveryTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeAvailableRecoveryTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Version' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4256E149-C3C4-4FA7-BDEA-13CA415E8763', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', 'description' => 'No relevant constraints are found.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DBInstanceName not found', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-07-10T02:23:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableZones'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '9026xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DatabaseNames' => ['description' => 'The name of the database. Format: "db1,db2".'."\n", 'type' => 'string', 'example' => 'db1,db2', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-xxxx-974F-CC7EA6DBxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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.', 'description' => ''],
['errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', 'description' => 'The page number cannot be found.'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'InvalidDBInstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceClass" is not valid.', 'description' => 'The instance type of the RDS instance is invalid.'],
['errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupDatabase'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeBackupDatabase',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'description' => '> This operation is phased out.'."\n",
],
'DescribeBackupPolicy' => [
'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 DescribeDBInstances to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'BackupPolicyMode',
'in' => 'query',
'schema' => ['description' => 'The backup type. Valid values:'."\n"
.'* **DataBackupPolicy**: data backup'."\n"
.'* **LogBackupPolicy**: log backup.', 'type' => 'string', 'required' => false, 'example' => 'DataBackupPolicy', 'title' => ''],
],
[
'name' => 'CompressType',
'in' => 'query',
'schema' => ['description' => 'The backup compression method. Valid values:'."\n"
.'* **0**: not compressed'."\n"
.'* **1**: zlib compression'."\n"
.'* **2**: parallel zlib compression'."\n"
.'* **4**: QuickLZ compression with fast restoration for individual databases and tables enabled'."\n"
.'* **8**: QuickLZ compression but fast restoration for individual databases and tables not yet supported.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ReleasedKeepPolicy',
'in' => 'query',
'schema' => ['description' => 'The archived backup data retention policy for deleted **MySQL** instances. Valid values:'."\n"
."\n"
.'* **None**: No archived backups are retained.'."\n"
.'* **Lastest**: Only the last archived backup is retained.'."\n"
.'* **All**: All archived backups are retained.', 'type' => 'string', 'required' => false, 'example' => 'Lastest', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'ArchiveBackupKeepCount' => ['description' => 'The number of archived backups retained for the **MySQL** instance.', 'type' => 'string', 'example' => '1', 'title' => ''],
'ArchiveBackupKeepPolicy' => ['description' => 'The retention cycle of archived backups for the **MySQL** instance.', 'type' => 'string', 'example' => 'ByMonth', 'title' => ''],
'ArchiveBackupRetentionPeriod' => ['description' => 'The number of days for which archived backups are retained for the **MySQL** instance.', 'type' => 'string', 'example' => '365', 'title' => ''],
'BackupInterval' => ['description' => 'The backup interval. Unit: minutes.'."\n"
.'* For MySQL instances, this parameter specifies the [high-frequency snapshot backup frequency](~~98818~~) (not the snapshot backup cycle).'."\n"
.'* For SQL Server instances, this parameter specifies the log backup frequency.', 'type' => 'string', 'example' => '30', 'title' => ''],
'BackupLog' => ['description' => 'Indicates whether log backup is enabled. Valid values:'."\n"
.'* **Enable**: enabled'."\n"
.'* **Disabled**: disabled'."\n"
."\n"
.'**For SQL Server instances:**'."\n"
."\n"
.'- **Enable** is returned only when instance log backup frequency is **every 5 minutes**.'."\n"
.'- When instance log backup frequency is **every 30 minutes** or **consistent with the data backup cycle**, this parameter returns **Disabled**. **Use the BackupInterval value as the reference**.', 'type' => 'string', 'example' => 'Enable', 'title' => ''],
'BackupMethod' => ['description' => 'The backup method for **SQL Server instances with cloud disks**. Valid values:'."\n"
.'* **Physical**: physical backup'."\n"
.'* **Snapshot**: snapshot backup.', 'type' => 'string', 'example' => 'Physical', 'title' => ''],
'BackupPriority' => ['description' => 'The backup settings for the secondary instance of an **SQL Server Enterprise Cluster Edition** instance. Valid values:'."\n"
.'- **1**: Secondary instance preferred.'."\n"
.'- **2**: Primary instance forced.'."\n"
."\n"
.'> This parameter is returned only when SupportModifyBackupPriority is True.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'BackupRetentionPeriod' => ['description' => 'The number of days for which data backups are retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
'Category' => ['description' => 'Indicates whether backup within seconds is enabled for the **MySQL** or **PostgreSQL** instance. Valid values:'."\n"
."\n"
.'- **Flash**: Enabled.'."\n"
.'- **Standard**: Disabled.'."\n"
."\n"
.'> This parameter takes effect only when the **BackupPolicyMode** parameter is set to **DataBackupPolicy**.', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
'CompressType' => ['description' => 'The backup compression method. Valid values:'."\n"
.'* **0**: not compressed'."\n"
.'* **1**: zlib compression'."\n"
.'* **2**: parallel zlib compression'."\n"
.'* **4**: QuickLZ compression with fast restoration for individual databases and tables enabled'."\n"
.'* **8**: QuickLZ compression but fast restoration for individual databases and tables not yet supported.', 'type' => 'string', 'example' => '1', 'title' => ''],
'EnableBackupLog' => ['description' => 'Indicates whether log backup is enabled. Valid values:'."\n"
.'* **1**: Enabled.'."\n"
.'* **0**: Disabled.'."\n"
."\n"
.'**For SQL Server instances:**'."\n"
.'- **1** is returned only when instance log backup frequency is **every 5 minutes**.'."\n"
.'- When instance log backup frequency is **every 30 minutes** or **consistent with the data backup cycle**, this parameter returns **0**. **Use the BackupInterval value as the reference**.', 'type' => 'string', 'example' => '1', 'title' => ''],
'EnableIncrementDataBackup' => ['description' => 'Indicates whether incremental backup is enabled for the **SQL Server** instance. Valid values:'."\n"
.'* **True**: Enabled.'."\n"
.'* **False**: Disabled.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'IncBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'EnablePitrProtection' => ['description' => 'Indicates whether point-in-time recovery (PITR) is enabled for the **MySQL** instance. PITR is an upgraded version of log backup. Valid values:'."\n"
.'- **True**: Enabled.'."\n"
.'- **False**: Disabled.'."\n"
."\n"
.'> For more information, see [Configure a point-in-time recovery policy](~~2666046~~).', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'HighSpaceUsageProtection' => ['description' => 'Indicates whether binary logs are forcibly deleted when the storage usage of the **MySQL** instance exceeds 80% or the remaining storage is less than 5 GB. Valid values:'."\n"
."\n"
.'* **Disable**: Binary logs are not forcibly deleted.'."\n"
.'* **Enable**: Binary logs are forcibly deleted.', 'type' => 'string', 'example' => 'Enable', 'title' => ''],
'LocalLogRetentionHours' => ['description' => 'The number of hours for which binary log backups are retained on the **MySQL** instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'LocalLogRetentionSpace' => ['description' => 'The maximum storage usage of binary logs on the **MySQL** instance, in percentage.', 'type' => 'string', 'example' => '30', 'title' => ''],
'LogBackupFrequency' => ['description' => 'The log backup frequency for the **SQL Server** instance. Valid values:'."\n"
."\n"
.'* **LogInterval**: A log backup is performed every 30 minutes.'."\n"
.'* Default: The log backup frequency is the same as the data backup cycle specified by **PreferredBackupPeriod**.', 'type' => 'string', 'example' => 'LogInterval', 'title' => ''],
'LogBackupLocalRetentionNumber' => ['description' => 'The number of local binary logs retained on the **MySQL** instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'LogBackupRetentionPeriod' => ['description' => 'The number of days for which log backups are retained.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
'PitrRetentionPeriod' => ['description' => 'The number of days for which point-in-time recovery is supported on the **MySQL** instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''],
'PreferredBackupPeriod' => ['description' => 'The data backup cycle. Multiple values are separated by commas (,). Valid values:'."\n"
.'* **Monday**: Monday'."\n"
.'* **Tuesday**: Tuesday'."\n"
.'* **Wednesday**: Wednesday'."\n"
.'* **Thursday**: Thursday'."\n"
.'* **Friday**: Friday'."\n"
.'* **Saturday**: Saturday'."\n"
.'* **Sunday**: Sunday.', 'type' => 'string', 'example' => 'Monday,Wednesday,Friday,Sunday', 'title' => ''],
'PreferredBackupTime' => ['description' => 'The data backup time. Format: HH:mmZ-HH:mmZ (UTC).', 'type' => 'string', 'example' => '15:00Z-16:00Z', 'title' => ''],
'PreferredNextBackupTime' => ['description' => 'The next backup time. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2018-01-19T15:15Z', 'title' => ''],
'ReleasedKeepPolicy' => ['description' => 'The archived backup data retention policy for deleted **MySQL** instances. Valid values:'."\n"
.'* **None**: No archived backups are retained.'."\n"
.'* **Lastest**: Only the last archived backup is retained.'."\n"
.'* **All**: All archived backups are retained.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B87E2AB3-B7C9-4394-9160-7F639F732031', 'title' => ''],
'SupportModifyBackupPriority' => ['description' => 'Indicates whether the secondary instance backup option can be modified for the **SQL Server** instance. Valid values:'."\n"
."\n"
.'- **True**: The option can be modified.'."\n"
.'- **False**: The option cannot be modified.', 'type' => 'boolean', 'example' => 'False', 'title' => ''],
'SupportReleasedKeep' => ['description' => 'A reserved parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'SupportVolumeShadowCopy' => ['description' => 'Indicates whether snapshot backup is supported for the **SQL Server** instance. Valid values:'."\n"
."\n"
.'- **1**: Supported.'."\n"
.'- **0**: Not supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SupportsHighFrequencyBackup' => ['description' => 'Indicates whether the [5-minute log backup feature](~~95717~~) is supported for the **SQL Server** instance. Valid values:'."\n"
.'- **0**: Not supported.'."\n"
.'- **1**: Supported.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'AdvancedDataPolicies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AdvancedDataPolicy' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StrategyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ActionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'OnlyPreserveOneEachHour' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'RetentionValue' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'BakType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FilterKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FilterValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DestType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FilterType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SrcRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'OnlyPreserveOneEachDay' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'SrcType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DestRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'RetentionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'AdvancedLogPolicies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AdvancedLogPolicy' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StrategyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'ActionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LogRetentionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DestType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'EnableLogBackup' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'SrcType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SrcRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'LogRetentionValue' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'DestRegion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FilterKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FilterValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'AdvancedBackupPolicyEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal failure, retry later.', 'description' => 'The request failed. Please try again later.'],
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'View instance backup settings',
'summary' => 'Queries the backup settings of an ApsaraDB RDS instance.',
'description' => '### Supported engines'."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-29T22:56:58.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-01-31T11:24:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-06-29T07:37:28.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-31T13:19:09.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeBackupPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","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 \\"IncBackupInterval\\": 0,\\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 \\"AdvancedDataPolicies\\": {\\n \\"AdvancedDataPolicy\\": [\\n {\\n \\"StrategyId\\": \\"\\",\\n \\"ActionType\\": \\"\\",\\n \\"OnlyPreserveOneEachHour\\": false,\\n \\"RetentionValue\\": 0,\\n \\"BakType\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"FilterType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"OnlyPreserveOneEachDay\\": false,\\n \\"SrcType\\": \\"\\",\\n \\"DestRegion\\": \\"\\",\\n \\"RetentionType\\": \\"\\"\\n }\\n ]\\n },\\n \\"AdvancedLogPolicies\\": {\\n \\"AdvancedLogPolicy\\": [\\n {\\n \\"StrategyId\\": \\"\\",\\n \\"ActionType\\": \\"\\",\\n \\"LogRetentionType\\": \\"\\",\\n \\"DestType\\": \\"\\",\\n \\"EnableLogBackup\\": 0,\\n \\"SrcType\\": \\"\\",\\n \\"SrcRegion\\": \\"\\",\\n \\"LogRetentionValue\\": 0,\\n \\"DestRegion\\": \\"\\",\\n \\"FilterKey\\": \\"\\",\\n \\"FilterValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"AdvancedBackupPolicyEnabled\\": false\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'Flag',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '无', 'default' => '1', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'BackupJobId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '476****', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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'],
'title' => '',
],
],
],
'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' => '34665****', 'title' => ''],
'BackupJobId' => ['description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => '476****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'JobMode' => ['description' => 'The backup mode. Valid values:'."\n"
."\n"
.'* **Automated**'."\n"
.'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''],
'Process' => ['description' => 'The progress of the task in percentage.'."\n", 'type' => 'string', 'example' => '25', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '90496720-2319-42A8-87CD-FCE4DF95EBED', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal failure, retry later.', 'description' => 'The request failed. Please try again later.'],
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeBackupTasks',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeBackups' => [
'summary' => 'This API is used to view the backup set list of an 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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '327329803', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup mode. Valid values:'."\n"
."\n"
.'* **Automated**'."\n"
.'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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/****', 'title' => ''],
'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', 'title' => ''],
'BackupId' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '321020562', 'title' => ''],
'BackupInitiator' => ['description' => 'The initiator of the backup task. Valid values:'."\n"
."\n"
.'* **System**'."\n"
.'* **User**'."\n", 'type' => 'string', 'example' => 'System', 'title' => ''],
'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/****', 'title' => ''],
'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', 'title' => ''],
'BackupMode' => ['description' => 'The backup mode of the backup set. Valid values:'."\n"
."\n"
.'* **Automated**'."\n"
.'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''],
'BackupSize' => ['description' => 'The size of the data backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2167808', 'title' => ''],
'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', 'title' => ''],
'BackupStatus' => ['description' => 'The state of the backup set.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
'BackupType' => ['description' => 'The backup type of the backup set. Valid values:'."\n"
."\n"
.'* **FullBackup**'."\n"
.'* **IncrementalBackup**'."\n", 'type' => 'string', 'example' => 'FullBackup', 'title' => ''],
'Checksum' => ['description' => 'The checksum. The value of this parameter is calculated by using the CRC64 algorithm.'."\n", 'type' => 'string', 'example' => '1835830439****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'Encryption' => ['description' => 'The encryption information about the backup set.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''],
'Engine' => ['description' => 'The type of the database engine. Valid values:'."\n"
."\n"
.'* MySQL'."\n"
.'* SQLServer'."\n"
.'* PostgreSQL'."\n"
.'* MariaDB'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ExpectExpireTime' => ['description' => 'The expiration time of the backup set, in the format yyyy-MM-ddTHH:mmZ (UTC time). '."\n"
.'> '."\n"
.'> - This value is returned only for single-database backups of SQL Server instances when **backup retention days** is configured. ', 'type' => 'string', 'example' => '2025-06-17T12:10:23Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of backup sets on the current page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', 'title' => ''],
'TotalEcsSnapshotSize' => ['description' => 'The size of the snapshot chain of the instance. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'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.', 'description' => ''],
['errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', 'description' => 'The page number cannot be found.'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', 'description' => 'The specified parameter DBinstanceClass is invalid.'],
['errorCode' => 'InvalidBackupSetLocation.Format', 'errorMessage' => 'Specified backup set location is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidMaxRecordsPerPage.Malformed', 'errorMessage' => 'Specified record number is not valid.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'View the list of RDS instance backup sets',
'description' => '### Supported Engines'."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-13T12:55:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-06T13:01:28.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-07-05T06:48:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-02T11:09:51.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-11T08:51:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-06-16T12:45:57.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-21T12:37:16.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackups'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeBackups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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://****.oss.aliyuncs.com/****', 'title' => ''],
'FileSize' => ['description' => 'The size of the log file.'."\n"
."\n"
.'Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2269410', 'title' => ''],
'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' => '584****', 'title' => ''],
'IntranetDownloadLink' => ['description' => 'The URL that is used to download files over an internal network.'."\n", 'type' => 'string', 'example' => 'http://****.oss-cn-hangzhou-internal.aliyuncs.com/****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'LogFileName' => ['description' => 'The log file name.'."\n", 'type' => 'string', 'example' => '000000040000000000000019', 'title' => ''],
'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',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of log files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ED169A3E-1657-4104-82AB-24EA8CD0DB75', 'title' => ''],
'TotalFileSize' => ['description' => 'The total size of the log file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2269410', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of log files.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', 'description' => 'The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', 'description' => 'You must pass in the required parameter.'],
['errorCode' => 'ServiceTemporarilyClosed', 'errorMessage' => 'Service temporarily closed.', 'description' => 'The task is closed.'],
['errorCode' => 'ReadDBInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => ''],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinlogFiles'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeBinlogFiles',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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*****', 'title' => ''],
],
],
'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","utf8","euckr","ascii"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Engine' => ['description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidEngine.Malformed', 'errorMessage' => 'Specified engine is not valid.', 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-21T09:58:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-11-15T09:39:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSetName'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ClassCode',
'in' => 'query',
'schema' => ['description' => 'The code of the instance type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rds.mysql.s3.large', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '5.6', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The type of the database engine.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MySQL', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'ClassCode' => ['description' => 'The code of the instance type.'."\n", 'type' => 'string', 'example' => 'mysql.n2.medium.1', 'title' => ''],
'ClassGroup' => ['description' => 'The instance family of the instance.'."\n", 'type' => 'string', 'example' => 'x', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '4', 'title' => ''],
'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', 'title' => ''],
'InstructionSetArch' => ['description' => 'The architecture of the instance.'."\n", 'type' => 'string', 'example' => 'x86', 'title' => ''],
'MaxConnections' => ['description' => 'The maximum number of connections.'."\n", 'type' => 'string', 'example' => '4000', 'title' => ''],
'MaxIOMBPS' => ['description' => 'The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''],
'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', 'title' => ''],
'MemoryClass' => ['description' => 'The memory size. Unit: GB.'."\n", 'type' => 'string', 'example' => '2GB', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34'],
],
'example' => '',
],
],
[],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidClassCode.NotFound', 'errorMessage' => 'Invalid ClassCode NotFound.', 'description' => 'The operation failed because the code of the instance type does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-07-25T01:51:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClassDetails'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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*', 'title' => ''],
'GmtCreated' => ['description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:57:41Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the task was modified.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:58:00Z', 'title' => ''],
'SourceAccount' => ['description' => 'The username.'."\n", 'type' => 'string', 'example' => 'migratetest', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SourcePassword' => ['description' => 'The password.'."\n", 'type' => 'string', 'example' => '123456', 'title' => ''],
'SourcePort' => ['description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', 'title' => ''],
'TargetEip' => ['description' => 'A reserved parameter. The return value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'TargetInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440420798', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'lxbv6rtxno8', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7E4A6E1B-789B-5F16-9736-39AA57FC7374', 'title' => ''],
'TotalSize' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudMigrationPrecheckResult'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCloudMigrationPrecheckResult',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'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', 'title' => ''],
'GmtCreated' => ['description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '2022-02-25T08:53:13Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the task was modified.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:39:51Z', 'title' => ''],
'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', 'title' => ''],
'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\\"}', 'title' => ''],
'ReplicationState' => ['description' => 'The status of data replication.'."\n"
."\n"
.'* **unstarted**'."\n"
.'* **catchup**'."\n"
.'* **streaming**'."\n"
.'* **disconnect**'."\n"
.'* **finish**'."\n", 'type' => 'string', 'example' => 'streaming', 'title' => ''],
'SourceAccount' => ['description' => 'The username.'."\n", 'type' => 'string', 'example' => 'migratetest', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SourcePassword' => ['description' => 'The password.'."\n", 'type' => 'string', 'example' => '123456', 'title' => ''],
'SourcePort' => ['description' => 'The port number that is used to connect to the self-managed PostgreSQL instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', 'title' => ''],
'SwitchTime' => ['description' => 'The time when the switchover was performed.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:40:51Z', 'title' => ''],
'TargetEip' => ['description' => 'A reserved parameter. The return value of this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'TargetInstanceName' => ['description' => 'The ID of the destination instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp102g323jd4****', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '440437220', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1B983C48-9793-5EAA-8F7F-00EAEC517675', 'title' => ''],
'TotalSize' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudMigrationResult'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCloudMigrationResult',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
'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)', 'title' => ''],
'TimeZone' => ['description' => 'The time zone.'."\n", 'type' => 'string', 'example' => 'Afghanistan Standard Time', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4EAED246-DB18-4C8D-9EB5-C319626F2A77', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-03-26T13:03:00.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollationTimeZones'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'pgm-2ze63v2p3o3k****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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"
.' }', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeComputeBurstConfig',
'description' => '### [](#)Supported database engine'."\n"
."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### [](#)References'."\n"
."\n"
.'[Assured serverless](~~2928780~~)'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:DescribeComputeBurstConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance to which the cross-region backup file belongs.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', 'title' => ''],
'TotalPageCount' => ['description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset', 'description' => ''],
['errorCode' => 'InvalidPageSize', 'errorMessage' => 'The page size is invalid', 'description' => 'The value of the pageSize parameter is invalid. The value of this parameter must be a number.'],
['errorCode' => 'InvalidPageIndex', 'errorMessage' => 'The page index is invalid', 'description' => ''],
['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidMeta.Empty', 'errorMessage' => 'Meta information is empty.', 'description' => 'The meta information is empty. Check whether a full backup has not been performed after the database table is restored.'],
['errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', 'description' => 'The metadata information is too large. Check whether the number of instance tables exceeds 50000.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter({}) is not valid.', 'description' => ''],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:48.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossBackupMetaList'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCrossBackupMetaList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'CrossBackupRegion' => ['description' => 'The ID of the destination region within which the cross-region backup file is stored.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
'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', 'title' => ''],
'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' => 'testdb', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status. For more information, see [Instance statuses](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ItemsNumbers' => ['description' => 'The total number of items returned for cross-region backup settings.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageNumber' => ['description' => 'The page number. Pages start from page 1.'."\n"
."\n"
.'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '33517002-182D-40BE-93EC-610BD3381045', 'title' => ''],
'TotalRecords' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified user is not found. Please check again.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionBackupDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCrossRegionBackupDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => '2024-03-05T02:21:00Z', 'title' => ''],
],
[
'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' => '2024-03-05T02:24:37Z', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '603524****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'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' => '2024-03-05T02:23:37Z', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'BackupStartTime' => ['description' => 'The time when the cross-region data backup started.'."\n", 'type' => 'string', 'example' => '2024-03-05T02:22:45Z', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ConsistentTime' => ['description' => 'The point in time that is indicated by the data in the cross-region data backup file.'."\n", 'type' => 'string', 'example' => '2024-03-05T02:22:54Z', 'title' => ''],
'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/****', 'title' => ''],
'CrossBackupId' => ['description' => 'The ID of the cross-region data backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1249****', 'title' => ''],
'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', 'title' => ''],
'CrossBackupSetFile' => ['description' => 'The name of the compressed package that contains the cross-region data backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb', 'title' => ''],
'CrossBackupSetLocation' => ['description' => 'The location where the cross-region data backup file is stored.'."\n", 'type' => 'string', 'example' => 'oss', 'title' => ''],
'CrossBackupSetSize' => ['description' => 'The size of the cross-region data backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5312836', 'title' => ''],
'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', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', 'title' => ''],
'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' => '8161***', 'title' => ''],
'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", "cn-shanghai"', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number. Pages start from page 1.'."\n"
."\n"
.'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of cross-region data backup files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60912B41-7579-4B5D-B289-8856030F0A6A', 'title' => ''],
'StartTime' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'example' => '2019-05-30T12:10:00Z', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', 'description' => 'The time format is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionBackups'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCrossRegionBackups',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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/****', 'title' => ''],
'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/****', 'title' => ''],
'CrossLogBackupId' => ['description' => 'The ID of the cross-region log backup file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '14567', 'title' => ''],
'CrossLogBackupSize' => ['description' => 'The size of the cross-region log backup file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5312836', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8161055', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'LogFileName' => ['description' => 'The name of the cross-region log backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou_rm-bp****_7198739_mysql-bin.000230', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number. Pages start from page 1.'."\n"
."\n"
.'Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of cross-region backup files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DAC241E8-28E6-49DA-BFB0-B2DD090885C1', 'title' => ''],
'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', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', 'description' => 'The time format is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionLogBackupFiles'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCrossRegionLogBackupFiles',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeCurrentModifyOrder' => [
'summary' => 'Query the latest upgrade/downgrade order 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 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', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''],
'DbInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-cn-nwy39qeys0003r', 'title' => ''],
'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', 'title' => ''],
'Mark' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => '无', 'title' => ''],
'MemoryClass' => ['description' => 'The memory capacity that is supported by the instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''],
'Status' => ['description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => 'Succeed,Scheduled,Running,Cancelling,Canceled,Waiting', 'title' => ''],
'Storage' => ['description' => 'The storage capacity of the instance.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'TargetDBInstanceClass' => ['description' => 'The new instance type of the instance. Valid values:'."\n", 'type' => 'string', 'example' => 'mysql.x2.medium.2c', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C87415BE-F5AB-55A4-A60E-A0A329EAF2A4'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOrderId.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', 'description' => 'The specified order does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query the latest upgrade/downgrade order for an instance ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCurrentModifyOrder'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCurrentModifyOrder',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DescribeCustinsResourceInfo' => [
'summary' => 'Query instance resource usage ',
'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-wz9s06u4drm******', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'CpuAdjustableMaxRatio' => ['description' => 'The maximum percentage of the system CPU resources that the instance can use.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''],
'CpuAdjustableMaxValue' => ['description' => 'The maximum CPU utilization.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''],
'CpuIncreaseRatio' => ['description' => 'The CPU utilization.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''],
'CpuIncreaseRatioValue' => ['description' => 'The CPU utilization. Unit: percentage.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => ' rm-wz9s06u4drm******', 'title' => ''],
'IopsAdjustableMaxValue' => ['description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'MaxConnAdjustDeadline' => ['description' => 'The deadline for the adjustment of the maximum number of connections.'."\n", 'type' => 'string', 'example' => '2023-10-25'."\n", 'title' => ''],
'MaxConnAdjustableMaxValue' => ['description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'MaxConnIncreaseRatio' => ['description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'MaxConnIncreaseRatioValue' => ['description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'MaxIopsAdjustDeadline' => ['description' => 'The deadline for the adjustment of the maximum IOPS.'."\n", 'type' => 'string', 'example' => '2023-10-25'."\n", 'title' => ''],
'MaxIopsIncreaseRatio' => ['description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'MaxIopsIncreaseRatioValue' => ['description' => 'The maximum IOPS that can be supported by the instance.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'MemAdjustableMaxRatio' => ['description' => 'The maximum percentage of the system memory that the instance can use.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''],
'MemAdjustableMaxValue' => ['description' => 'The maximum value of the resources to be evaluated.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'MemoryAdjustDeadline' => ['description' => 'The deadline for the memory adjustment.'."\n", 'type' => 'string', 'example' => '2023-10-25', 'title' => ''],
'MemoryIncreaseRatio' => [
'description' => 'The memory increase percentage.'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => '20',
'title' => '',
],
'MemoryIncreaseRatioValue' => ['description' => 'The memory usage. Unit: MB.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'OriginCpu' => ['description' => 'The number of CPUs of the instance.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'OriginMaxConn' => ['description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''],
'OriginMaxIops' => ['description' => 'The maximum IOPS.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
'OriginMemory' => ['description' => 'The actual memory used. Unit: MB.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', 'description' => ''],
['errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', 'description' => ''],
['errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', 'description' => ''],
['errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', 'description' => ''],
['errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', 'description' => 'The specified InsName parameter is invalid.'],
['errorCode' => 'ClusterTypeError', 'errorMessage' => 'The Custins cluster type encounters an error. Standard cluster is not supported.', 'description' => 'The Custins cluster type is invalid. Only the user cluster type is supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', 'description' => 'The Custins cluster type is invalid. Only the user cluster type is supported.'],
['errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'PhysicalCustins.NotFound', 'errorMessage' => 'Physical Custins Not Found!', 'description' => ''],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'Current cluster not found host info!', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query instance resource usage',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustinsResourceInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeCustinsResourceInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDBInstanceAttribute' => [
'summary' => 'Queries the details of 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 ID of the instance. Call the DescribeDBInstances operation to query instance IDs.'."\n"
.'>Do not specify multiple instance IDs in a single request. This may cause the query to time out.>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'Expired',
'in' => 'query',
'schema' => ['description' => 'Indicates whether the instance is expired. Valid values:'."\n"
."\n"
.'- **True**: The instance is expired.'."\n"
."\n"
.'- **False**: The instance is not expired.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'False', 'example' => 'False', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The details of the returned parameters.',
'type' => 'object',
'properties' => [
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBInstanceAttribute' => [
'description' => 'An array that consists of the attributes of the instance.',
'type' => 'array',
'items' => [
'description' => 'The details of the instance attributes.',
'type' => 'object',
'properties' => [
'AccountMaxQuantity' => ['description' => 'The maximum number of accounts that can be created on the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
'AdvancedFeatures' => ['description' => 'This parameter is returned only for an RDS for SQL Server instance. It indicates the advanced features that are enabled. If multiple advanced features are enabled, the features are separated by commas (,). Valid values:'."\n"
."\n"
.'- **LinkedServer**: linked server'."\n"
."\n"
.'- **DistributeTransaction**: distributed transaction', 'type' => 'string', 'example' => 'LinkedServer', 'title' => ''],
'AutoUpgradeMinorVersion' => ['description' => 'The update method for the minor engine version. Valid values:'."\n"
."\n"
.'- **Auto**: The minor engine version is automatically updated.'."\n"
."\n"
.'- **Manual**: The minor engine version is not automatically updated. You must manually update the minor engine version.', 'type' => 'string', 'example' => 'Auto', 'title' => ''],
'AvailabilityValue' => ['description' => 'The service availability of the instance in percentages.', 'type' => 'string', 'example' => '100.0%', 'title' => ''],
'BabelfishConfig' => [
'description' => 'The configuration of [Babelfish for ApsaraDB RDS for PostgreSQL](~~428613~~).',
'type' => 'object',
'properties' => [
'BabelfishEnabled' => ['description' => 'Indicates whether Babelfish is enabled.'."\n"
."\n"
.'> If you enable Babelfish when you create an ApsaraDB RDS for PostgreSQL instance, this parameter is always **true**.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'MigrationMode' => ['description' => 'The [migration mode](~~428613~~) for Babelfish. Valid values:'."\n"
."\n"
.'- **single-db**: single-database mode'."\n"
."\n"
.'- **multi-db**: multi-database mode', 'type' => 'string', 'example' => 'single-db', 'title' => ''],
],
'title' => '',
'example' => '',
],
'IsAnalyticIns' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'CanTempUpgrade' => ['description' => 'Indicates whether the instance is eligible for a temporary upgrade.'."\n"
."\n"
.'> This feature is not supported for pay-as-you-go instances.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Category' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **Basic**: Basic Edition'."\n"
."\n"
.'- **HighAvailability**: High-availability Edition'."\n"
."\n"
.'- **cluster**: Cluster Edition for ApsaraDB RDS for MySQL'."\n"
."\n"
.'- **AlwaysOn**: Cluster Edition for ApsaraDB RDS for SQL Server'."\n"
."\n"
.'- **Finance**: Enterprise Edition'."\n"
."\n"
.'- **Serverless\\_basic**: Serverless Basic Edition', 'type' => 'string', 'example' => 'Basic', 'title' => ''],
'ColdDataEnabled' => ['description' => 'Indicates whether the [data archiving](~~2701832~~) feature is enabled for the ESSD. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false**: The feature is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Collation' => ['description' => 'The character set collation.', 'type' => 'string', 'example' => 'Chinese_PRC_CI_AS', 'title' => ''],
'ConnectionMode' => ['description' => 'The connection mode of the instance. Valid values:'."\n"
."\n"
.'- **Standard**: standard connection mode'."\n"
."\n"
.'- **Safe**: database proxy mode', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
'ConnectionString' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
'ConsoleVersion' => ['description' => 'The type of the database proxy. Valid values:'."\n"
."\n"
.'- **1**: shared database proxy'."\n"
."\n"
.'- **2**: dedicated database proxy'."\n"
."\n"
.'> We recommend that you use the **ProxyType** parameter instead.', 'type' => 'string', 'example' => '2', 'title' => ''],
'CreationTime' => ['description' => 'The time when the instance was created. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2011-05-30T12:11:04Z', 'title' => ''],
'CurrentKernelVersion' => ['description' => 'The minor engine version of the instance.', 'type' => 'string', 'example' => 'rds_20201010', 'title' => ''],
'DBClusterNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBClusterNode' => [
'description' => 'The details of the nodes in the cluster.',
'type' => 'array',
'items' => [
'description' => 'The details of the node.',
'type' => 'object',
'properties' => [
'ClassCode' => ['description' => 'The instance type of the node.', 'type' => 'string', 'example' => 'mysql.n2.medium.xc', 'title' => ''],
'ClassType' => ['description' => 'The instance family of the node. Valid values:'."\n"
."\n"
.'- d: dedicated'."\n"
."\n"
.'- x: general-purpose', 'type' => 'string', 'example' => 'x', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores of the node.', 'type' => 'string', 'example' => '4', 'title' => ''],
'Memory' => ['description' => 'The memory size of the node. Unit: MB.', 'type' => 'string', 'example' => '4096', 'title' => ''],
'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'rn-****', 'title' => ''],
'NodeRegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'NodeRole' => ['description' => 'The role of the node. Valid values:'."\n"
."\n"
.'- **primary**: primary node'."\n"
."\n"
.'- **secondary**: secondary node', 'type' => 'string', 'example' => 'primary', 'title' => ''],
'NodeZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''],
'Status' => ['description' => 'The state of the node. Valid values:'."\n"
."\n"
.'- active'."\n"
."\n"
.'- creating'."\n"
."\n"
.'- deleting'."\n"
."\n"
.'- classchanging'."\n"
."\n"
.'- restarting', 'type' => 'string', 'example' => 'active', 'title' => ''],
'DisasterRecoveryNode' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DBInstanceCPU' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''],
'DBInstanceClass' => ['description' => 'The instance type. For more information, see [Instance types]().', 'type' => 'string', 'example' => 'rds.mys2.small', 'title' => ''],
'DBInstanceClassType' => ['description' => 'The instance family. Valid values:'."\n"
."\n"
.'- **s**: shared'."\n"
."\n"
.'- **x**: general-purpose'."\n"
."\n"
.'- **d**: dedicated'."\n"
."\n"
.'- **h**: dedicated host', 'type' => 'string', 'example' => 's', 'title' => ''],
'DBInstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'testInstance', 'title' => ''],
'DBInstanceDiskUsed' => ['description' => 'The used storage space of the instance. Unit: bytes.'."\n"
."\n"
.'>'."\n"
."\n"
.'For a serverless ApsaraDB RDS for MySQL instance, this parameter returns **0** if the instance is stopped.'."\n"
."\n"
.'>', 'type' => 'string', 'example' => '300', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceMemory' => ['description' => 'The memory size of the instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''],
'DBInstanceNetType' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **Internet**: The instance is connected over the Internet.'."\n"
."\n"
.'- **Intranet**: The instance is connected over the internal network.', 'type' => 'string', 'example' => 'Internet', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The state of the instance. For more information, see [Instance states]().', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'DBInstanceStorage' => ['description' => 'The total storage space of the instance. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'DBInstanceStorageType' => ['description' => 'The storage type of the instance. Valid values:'."\n"
."\n"
.'- **local\\_ssd** and **ephemeral\\_ssd**: local SSDs'."\n"
."\n"
.'- **cloud\\_ssd**: standard SSDs'."\n"
."\n"
.'- **general\\_essd**: general-purpose ESSDs'."\n"
."\n"
.'- **cloud\\_essd0**: PL0 ESSDs'."\n"
."\n"
.'- **cloud\\_essd**: PL1 ESSDs'."\n"
."\n"
.'- **cloud\\_essd2**: PL2 ESSDs'."\n"
."\n"
.'- **cloud\\_essd3**: PL3 ESSDs', 'type' => 'string', 'example' => 'local_ssd', 'title' => ''],
'DBInstanceType' => ['description' => 'The role of the instance. Valid values:'."\n"
."\n"
.'- **Primary**: primary instance'."\n"
."\n"
.'- **Readonly**: read-only instance'."\n"
."\n"
.'- **Guard**: disaster recovery instance'."\n"
."\n"
.'- **Temp**: temporary instance', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'DBMaxQuantity' => ['description' => 'The maximum number of databases that can be created on the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'DedicatedHostGroupId' => ['description' => 'The dedicated cluster ID.', 'type' => 'string', 'example' => 'dhg-7a9*****', 'title' => ''],
'DeletionProtection' => ['description' => 'Indicates whether release protection is enabled. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false**: The feature is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DisasterRecoveryInfo' => ['description' => 'The details of the disaster recovery source instance.', 'type' => 'string', 'example' => '{"replicatorAccount": "******","sourcePort":******,"sourceAddress": "pgm-2ze******","sourceCategory": "aliyunRDS","sourceInstanceRegionId": "cn-******","replicatorPassword": "******","sourceInstanceName": "pgm-2ze******"}', 'title' => ''],
'DisasterRecoveryInstances' => ['description' => 'The disaster recovery instances of the current instance.', 'type' => 'string', 'example' => '[{"regionId":"cn-******","insName":"pgm-2ze******"},{"regionId":"cn-******","insName":"pgm-2ze******"}]', 'title' => ''],
'Engine' => ['description' => 'The database engine. Valid values:'."\n"
."\n"
.'- **MySQL**'."\n"
."\n"
.'- **PostgreSQL**'."\n"
."\n"
.'- **SQLServer**'."\n"
."\n"
.'- **MariaDB**', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''],
'ExpireTime' => ['description' => 'The time when the subscription instance expires. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n"
."\n"
.'> This parameter is not returned for pay-as-you-go instances.', 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', 'title' => ''],
'Extra' => [
'description' => 'The extended information about the instance.',
'type' => 'object',
'properties' => [
'AccountSecurityPolicy' => ['description' => 'The password policy for database accounts. Valid values:'."\n"
."\n"
.'- **MaximumPasswordAge**: the maximum password age'."\n"
."\n"
.'- **MinimumPasswordAge**: the minimum password age', 'type' => 'string', 'example' => '{"MaximumPasswordAge": 42,"MinimumPasswordAge": 30}', 'title' => ''],
'DBInstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBInstanceId' => [
'description' => 'The list of database instance IDs.',
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RecoveryModel' => [
'description' => 'The recovery model.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'Simple:简单恢复模式。'."\n"
.'Full:完整恢复模式。',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'GeneralGroupName' => ['description' => 'The name of the dedicated cluster to which the ApsaraDB MyBase for MySQL instance belongs.', 'type' => 'string', 'example' => 'TestGroup', 'title' => ''],
'GuardDBInstanceId' => ['description' => 'The ID of the disaster recovery instance that is attached to the instance.', 'type' => 'string', 'example' => 'rm-uf64zsu****', 'title' => ''],
'IPType' => ['description' => 'The IP address type. Only **IPv4** is supported.', 'type' => 'string', 'example' => 'IPv4', 'title' => ''],
'IncrementSourceDBInstanceId' => ['description' => 'The ID of the source instance for incremental data synchronization. This parameter is returned for read-only instances and disaster recovery instances. If this parameter is not returned, the instance is a primary instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **Classic**: classic network'."\n"
."\n"
.'- **VPC**: virtual private cloud (VPC)', 'type' => 'string', 'example' => 'Classic', 'title' => ''],
'InstructionSetArch' => ['description' => 'The CPU architecture of the instance. Valid values:'."\n"
."\n"
.'- **x86**'."\n"
."\n"
.'- **arm**', 'type' => 'string', 'example' => 'x86', 'title' => ''],
'IoAccelerationEnabled' => ['description' => 'Indicates whether the [Buffer Pool Extension (BPE)](~~2527067~~) feature is enabled for the ESSD. Valid values:'."\n"
."\n"
.'- **1**: The feature is enabled.'."\n"
."\n"
.'- **0**: The feature is disabled.', 'type' => 'string', 'example' => '0', 'title' => ''],
'LatestKernelVersion' => ['description' => 'The latest kernel version supported by the instance.', 'type' => 'string', 'example' => 'rds_20231031', 'title' => ''],
'LockMode' => ['description' => 'The lock state of the instance. Valid values:'."\n"
."\n"
.'- **Unlock**: The instance is not locked.'."\n"
."\n"
.'- **ManualLock**: The instance is manually locked.'."\n"
."\n"
.'- **LockByExpiration**: The instance is automatically locked after it expires.'."\n"
."\n"
.'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n"
."\n"
.'- **LockByDiskQuota**: The instance is automatically locked after its storage is full.'."\n"
."\n"
.'- **LockReadInstanceByDiskQuota**: The read-only instance is automatically locked after its storage is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''],
'LockReason' => ['description' => 'The reason why the instance is locked.', 'type' => 'string', 'example' => 'instance_expired', 'title' => ''],
'MaintainTime' => ['description' => 'The maintenance window. The time is in the \\`HH:mmZ-HH:mmZ\\` format and is displayed in UTC. For example, a value of \\`00:00Z-02:00Z\\` indicates that the instance can be maintained from 08:00 to 10:00 (UTC+8).', 'type' => 'string', 'example' => '00:00Z-02:00Z', 'title' => ''],
'MasterInstanceId' => ['description' => 'The ID of the primary instance.'."\n"
."\n"
.'> If this parameter is not returned, the current instance is the primary instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'MasterZone' => ['description' => 'The ID of the primary zone.', 'type' => 'string', 'example' => '5454284', 'title' => ''],
'MaxConnections' => ['description' => 'The maximum number of concurrent connections.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'MaxIOMBPS' => ['description' => 'The maximum I/O throughput. Unit: MB/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'MaxIOPS' => ['description' => 'The maximum IOPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''],
'MultipleTempUpgrade' => ['description' => 'Indicates whether the instance is undergoing a temporary upgrade. This parameter is returned only if the instance is undergoing a temporary upgrade.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PGBouncerEnabled' => ['description' => 'Indicates whether PgBouncer is enabled.'."\n"
."\n"
.'> This parameter is returned only for ApsaraDB RDS for PostgreSQL instances.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription'."\n"
."\n"
.'- **SERVERLESS**: serverless', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'Port' => ['description' => 'The port that is used to connect to the instance over an internal network.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'ProxyType' => ['description' => 'The type of database proxy that the instance supports. Valid values:'."\n"
."\n"
.'- **0**: The instance does not support database proxies.'."\n"
."\n"
.'- **1**: The instance supports shared database proxies.'."\n"
."\n"
.'- **2**: The instance supports dedicated database proxies.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ReadOnlyDBInstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyDBInstanceId' => [
'description' => 'An array that consists of the IDs of the read-only instances that are attached to the primary instance.',
'type' => 'array',
'items' => [
'description' => 'The details of the read-only instance.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The read-only instance ID.', 'type' => 'string', 'example' => 'rm-bp****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ReadonlyInstanceSQLDelayedTime' => ['description' => 'The data replication latency between the primary and read-only instances. Unit: seconds.', 'type' => 'string', 'example' => '30', 'title' => ''],
'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou ', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'SecurityIPList' => ['description' => 'The IP addresses in the whitelist.', 'type' => 'string', 'example' => '192.168.XX.XX/24', 'title' => ''],
'SecurityIPMode' => ['description' => 'The whitelist mode of the instance. Valid values:'."\n"
."\n"
.'- **normal**: standard whitelist mode'."\n"
."\n"
.'- **safety**: enhanced whitelist mode', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'ServerlessConfig' => [
'description' => 'The configurations of the serverless instance.',
'type' => 'object',
'properties' => [
'AutoPause' => ['description' => 'Indicates whether the auto-pause feature is enabled for the serverless instance. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false** (default): The feature is disabled.'."\n"
."\n"
.'> If no connections are established to the instance within 10 minutes, the instance is paused. The instance automatically resumes when a connection is established.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScaleMax' => ['description' => 'The maximum number of RDS Capacity Units (RCUs).', 'type' => 'number', 'format' => 'double', 'example' => '8', 'title' => ''],
'ScaleMin' => ['description' => 'The minimum number of RDS Capacity Units (RCUs).', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''],
'SwitchForce' => ['description' => 'Indicates whether the force-scaling feature is enabled for the serverless instance. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false** (default): The feature is disabled.'."\n"
."\n"
.'> RCU scaling for an instance usually takes effect immediately. In rare cases, the scaling may fail. If a scaling fails, you can enable this feature to forcibly scale the RCUs of the instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'SlaveZones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SlaveZone' => [
'description' => 'The details of the secondary zone.',
'type' => 'array',
'items' => [
'description' => 'The details of the zone.',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'SuperPermissionMode' => ['description' => 'Indicates whether the instance supports features such as privileged accounts, Active Directory (AD) authentication, and host accounts. Valid values:'."\n"
."\n"
.'- **Enable**: The instance supports the features.'."\n"
."\n"
.'- **Disabled**: The instance does not support the features.', 'type' => 'string', 'example' => 'Disabled', 'title' => ''],
'TempDBInstanceId' => ['description' => 'The ID of the temporary instance that is attached to the instance.', 'type' => 'string', 'example' => 'rm-uf64zsu****', 'title' => ''],
'TempUpgradeTimeEnd' => ['description' => 'The end time of the temporary upgrade.'."\n"
."\n"
.'> This parameter is not returned for pay-as-you-go instances.', 'type' => 'string', 'example' => '2024-05-30 00:00:00', 'title' => ''],
'TempUpgradeTimeStart' => ['description' => 'The start time of the temporary upgrade.'."\n"
."\n"
.'> This parameter is not returned for pay-as-you-go instances.', 'type' => 'string', 'example' => '2024-05-29 00:00:00', 'title' => ''],
'TimeZone' => ['description' => 'The time zone of the instance.', 'type' => 'string', 'example' => 'Central Standard Time', 'title' => ''],
'Tips' => ['description' => 'Information about an exception that is detected on a general-purpose ApsaraDB MyBase for MySQL instance.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'TipsLevel' => ['description' => 'The severity of the exception that is detected on a general-purpose ApsaraDB MyBase for MySQL instance. Valid values:'."\n"
."\n"
.'- **1**: Normal'."\n"
."\n"
.'- **2**: The specifications of the read-only instance and the primary instance are different. This may affect the availability of the instance. Adjust the specifications of the instance as needed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-****', 'title' => ''],
'VpcCloudInstanceId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-23rsxdf****', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-****', 'title' => ''],
'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'kindCode' => ['description' => 'An internal parameter. You do not need to specify this parameter.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'OptimizedWritesInfo' => ['description' => 'Information about the 16 KB atomic write feature. The value is a JSON string that contains the following fields:'."\n"
."\n"
.'- **optimized\\_writes**: Indicates whether the feature is enabled.'."\n"
."\n"
.'- **init\\_optimized\\_writes**: Indicates whether the feature can be enabled.', 'type' => 'string', 'example' => '{"optimized_writes":true,"init_optimized_writes":true}', 'title' => ''],
'CompressionMode' => ['description' => 'The storage compression mode. Valid values: on and off.', 'type' => 'string', 'example' => 'on, off', 'title' => ''],
'SupportCompression' => ['description' => 'Indicates whether the instance supports storage compression.', 'type' => 'boolean', 'example' => 'true, false', 'title' => ''],
'CompressionRatio' => ['description' => 'The storage compression ratio.', 'type' => 'string', 'example' => '1.25', 'title' => ''],
'BlueGreenDeploymentName' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'GreenInstanceName' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'BlueInstanceName' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'ComputeBurstEnabled' => ['description' => 'This parameter is reserved.', 'type' => 'boolean', 'example' => 'None', 'title' => ''],
'ReadOnlyStatus' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'BurstingEnabled' => ['description' => 'Indicates whether the [performance burst](~~2340501~~) feature is enabled for the ESSD. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false**: The feature is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'IsAnalyticReadOnlyIns' => ['description' => 'Indicates whether the instance is a [MySQL DuckDB analytic instance](~~2950002~~). Valid values:'."\n"
."\n"
.'- **true**: The instance is a MySQL DuckDB analytic instance.'."\n"
."\n"
.'- **false**: The instance is not a MySQL DuckDB analytic instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'VectorSupportStatus' => [
'title' => 'Vector support status ',
'description' => 'The status of vector support.',
'type' => 'string',
'example' => 'ON',
'enum' => ['None', 'ON', 'OFF'],
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ConnectTimeoutRetryLater', 'errorMessage' => 'Connect timeout retry later.', 'description' => 'The connection timed out. Please try again later.'],
['errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, please retry later.', 'description' => ''],
['errorCode' => 'DataNotExist', 'errorMessage' => 'Data not exist.', 'description' => 'No data is available.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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 \\"IsAnalyticIns\\": false,\\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\\": false\\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}","type":"json"}]',
'title' => 'Query instance details',
'description' => '### Applicable engines'."\n"
."\n"
.'- RDS for MySQL'."\n"
."\n"
.'- RDS for PostgreSQL'."\n"
."\n"
.'- RDS for SQL Server'."\n"
."\n"
.'- RDS for MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-05-07T13:13:29.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-04-09T13:01:13.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-02-18T03:09:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-24T15:55:38.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-12-03T13:01:03.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-10-15T09:01:24.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-08-29T22:56:58.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-06-27T13:29:36.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-05-23T14:07:50.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-01-04T11:54:29.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-11-15T09:56:03.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-10-11T13:44:47.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-06-27T11:30:07.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-01T02:03:23.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-19T09:53:21.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-05T15:08:33.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'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', 'title' => ''],
'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Tag.NoRegionIdExist', 'errorMessage' => 'the region Id can not be blank.', 'description' => 'The RegionId parameter cannot be empty. Specify this parameter.'],
['errorCode' => 'Tag.NoTagInfoExist', 'errorMessage' => 'all the tags and tagN parameters is null.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Tag.TagKeyCanNotBeAll', 'errorMessage' => 'tag key can not be all.', 'description' => 'The operation failed. Check the value of the TagKey parameter.'],
['errorCode' => 'Tag.TagKeyDuplex', 'errorMessage' => 'tag key must be sole in one operation.', 'description' => 'The tag has been added to the RDS instance. Define a different tag.'],
['errorCode' => 'Tag.NoDBInstanceIdExist', 'errorMessage' => 'the dbinstance Id can not be blank.', 'description' => 'The database instance ID must not be empty.'],
['errorCode' => 'Tag.TooManyDBInstanceIds', 'errorMessage' => 'the dbinstance Ids is more than 30.', 'description' => 'The number of database instance ID must not exceed 30.'],
['errorCode' => 'Tag.TooManyTagsForOneInstance', 'errorMessage' => 'total 10 tags can be added to one resource.', 'description' => 'The number of tags exceeds the maximum number of tags that is allowed. The maximum number is 10.'],
['errorCode' => 'Tag.SetTagInfoAtTwoParamters', 'errorMessage' => 'only tags or tagN parameter could be setted.', 'description' => 'The settings of the tag are invalid.'],
['errorCode' => 'Tag.Allow5TagInfos', 'errorMessage' => 'only 5 tags allowed in one operation.', 'description' => 'The operation failed. You can specify up to five tags at a time.'],
['errorCode' => 'Tag.TagKeyIsBlank', 'errorMessage' => 'tag key can not be blank.', 'description' => 'The tag is invalid. The key of the tag cannot be left unspecified.'],
['errorCode' => 'Tag.TagKeyStartWith.aliyun', 'errorMessage' => 'tag key and value can not be started with aliyun.', 'description' => 'The tag is invalid. The key of the tag cannot start with aliyun.'],
['errorCode' => 'Tag.TagKeyTooLong', 'errorMessage' => 'the max tag key s length is 64.', 'description' => 'The key of the tag exceeds 64 characters in length. Modify the key of the tag.'],
['errorCode' => 'Tag.TagValueTooLong', 'errorMessage' => 'the max tag value is length is 128.', 'description' => 'The value of the tag exceeds the maximum length that is allowed. The maximum length is 128 characters. Modify the value of the tag.'],
['errorCode' => 'Tag.InvalidTagsParamter', 'errorMessage' => 'tags parameter is invalid.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Tag.Malformed', 'errorMessage' => 'The specified parameter Tag is not valid.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created and whether the RDS instance has not been deleted.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceByTags'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceByTags',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeDBInstanceCLS' => [
'summary' => 'Returns the column encryption algorithm configuration for a specified instance.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0073A98-52F1-3075-8256-3943F*******', 'title' => ''],
'EncryptionKey' => ['description' => 'The ID of the custom key in Key Management Service (KMS).
**Note** This parameter is returned only when `EncryptionKeyMode` is set to `kms_key`.
', 'type' => 'string', 'example' => '749c1df7-****-****-****-****', 'title' => ''],
'EncryptionKeyMode' => ['description' => 'The column-level encryption mode. Valid values:'."\n"
."\n"
.'- `client_key`: A randomly generated key configured on the client.'."\n"
."\n"
.'- `kms_key`: A custom key configured in Key Management Service (KMS).'."\n"
."\n"
.'**Note** After you configure an instance to use a key from KMS, you cannot switch back to using a client-side key.', 'type' => 'string', 'example' => 'kms_key', 'title' => ''],
'Algorithm' => ['description' => 'The encryption algorithm. Valid values:'."\n"
."\n"
.'- AES\\_128\\_CBC'."\n"
."\n"
.'- AES\\_128\\_GCM'."\n"
."\n"
.'- AES\\_128\\_CTR'."\n"
."\n"
.'- AES\\_128\\_ECB'."\n"
."\n"
.'- AES\\_256\\_CBC'."\n"
."\n"
.'- AES\\_256\\_GCM'."\n"
."\n"
.'- AES\\_256\\_CTR'."\n"
."\n"
.'- AES\\_256\\_ECB'."\n"
."\n"
.'- SM4\\_128\\_CBC'."\n"
."\n"
.'- SM4\\_128\\_GCM'."\n"
."\n"
.'- SM4\\_128\\_CTR'."\n"
."\n"
.'- SM4\\_128\\_ECB', 'type' => 'string', 'example' => 'AES_256_GCM', 'title' => ''],
'WhiteListMode' => ['description' => 'Indicates whether the whitelist mode is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'The operation failed. The RDS instance cannot be connected. Please try again later.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', 'description' => ''],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
['errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', 'description' => 'The size of the database exceeds the maximum size that is allowed.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', 'description' => 'The operation failed. The instance name cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query Column Encryption Algorithm Configuration',
'description' => '## Before you begin'."\n"
."\n"
.'- Before calling this operation, ensure that the column encryption service is enabled in the DAS Security Center.'."\n"
."\n"
.'- If you receive the `ColumnEncryptionErrorCode.NOT_PURCHASED` error, purchase and enable the column encryption service in the DAS (Database Autonomy Service) Security Center and try again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceCLS',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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"}]',
],
'DescribeDBInstanceConnectivity' => [
'summary' => 'Obtain instance ingest endpoint diagnosis information ',
'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****', 'title' => ''],
],
[
'name' => 'DbInstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4ns09hgoy99i5gez', 'title' => ''],
],
[
'name' => 'SourceIpAddress',
'in' => 'query',
'schema' => ['description' => 'The source IP address.'."\n", 'type' => 'string', 'required' => true, 'example' => '172.16.XX.XX', 'title' => ''],
],
],
'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', 'title' => ''],
'ConnCheckErrorMessage' => ['description' => 'The error message for connection diagnosis.'."\n", 'type' => 'string', 'example' => 'Src ip:39.106.64.59 not in user whitelist', 'title' => ''],
'ConnCheckResult' => ['description' => 'The connection diagnosis result. Valid values:'."\n"
."\n"
.'* **Success**'."\n"
.'* **Failed**'."\n", 'type' => 'string', 'example' => 'Failed', 'title' => ''],
'DbInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2ze2za3is7baay1w4', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D880212A-F21F-5722-8422-BD06B2874CC3'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Check connectivity timeout', 'description' => 'Connectivity Check Timeout'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query database instance connection ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConnectivity'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceConnectivity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp6wjk5xxxxxxxxxx', 'title' => ''],
'LicenseType' => ['description' => 'The type of the license.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '06B220E2-EAC5-4DBE-A1FC-1B62DB6A****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidEngine.NotSupported', 'errorMessage' => 'Current engine does not support this api.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:48.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDetail'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceDetail',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the custom key.'."\n", 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'Description' => ['description' => 'The description of the key.'."\n", 'type' => 'string', 'example' => 'Description of the key', 'title' => ''],
'EncryptionKey' => ['description' => 'The ID of the key.'."\n", 'type' => 'string', 'example' => '5306d1b6-7fd3-42d9-9511-****', 'title' => ''],
'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/****', 'title' => ''],
'Creator' => ['description' => 'The user who created the key.'."\n", 'type' => 'string', 'example' => '1443****9604', 'title' => ''],
'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', 'title' => ''],
'Description' => ['description' => 'The description of the key.'."\n", 'type' => 'string', 'example' => 'Description of the key', 'title' => ''],
'EncryptionKey' => ['description' => 'The ID of the key.'."\n", 'type' => 'string', 'example' => '5306d1b6-7fd3-42d9-9511-****', 'title' => ''],
'EncryptionKeyStatus' => ['description' => 'The status of the key. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'KeyType' => ['description' => 'The type of the key. Valid values:'."\n"
."\n"
.'* **CMK**'."\n"
.'* **ServiceKey**', 'type' => 'string', 'example' => 'ServiceKey', 'title' => ''],
'KeyUsage' => ['description' => 'The purpose of the key.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''],
'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', 'title' => ''],
'Origin' => ['description' => 'The source of the key.'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''],
'UsedBy' => ['description' => 'The role of the instance. Valid values:'."\n"
."\n"
.'* **Master**: primary instance'."\n"
.'* **slave**: read-only instance'."\n", 'type' => 'string', 'example' => 'TDE', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'EncryptionKeyStatus' => ['description' => 'The status of the key. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'KeyUsage' => ['description' => 'The purpose of the key.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''],
'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', 'title' => ''],
'Origin' => ['description' => 'The source of the key.'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3BC2768E-DEDA-40FC-BBE9-6B884F3626AF', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'NoActiveBYOK', 'errorMessage' => 'This custins no active byok.', 'description' => 'The disk encryption feature has not been enabled for the instance.'],
['errorCode' => 'ByokInsnameAndRegionAllEmpty', 'errorMessage' => 'The insName and targetRegionId can\'t be all empty.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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 Aliyun_KMS\\n Description of the key\\n Enabled\\n 3BC2768E-DEDA-40FC-BBE9-6B884F3626AF\\n 2021-10-18T08:14:16Z\\n ENCRYPT/DECRYPT\\n 5306d1b6-7fd3-42d9-9511-xxxxxxx\\n 1443*****9604\\n 2022-05-08T08:14:16Z\\n","errorExample":""}]',
'title' => 'DescribeDBInstanceEncryptionKey',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-05-11T08:59:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-12T08:43:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-12-15T06:16:31.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-12-07T10:07:45.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceEncryptionKey'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceEncryptionKey',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'IpAddress' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '10.71.XX.XX', 'title' => ''],
'IpType' => ['description' => 'The type of the IP address. Valid values:'."\n"
."\n"
.'* **Public**: Internet'."\n"
.'* **Private**: internal network'."\n", 'type' => 'string', 'example' => 'Private', 'title' => ''],
'Port' => ['description' => 'The port number of the endpoint.'."\n", 'type' => 'string', 'example' => '3306', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp12u14ecz****', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-bp17xdic25d****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'EndpointDescription' => ['description' => 'The user-defined description of the endpoint.'."\n", 'type' => 'string', 'example' => 'for readonly business', 'title' => ''],
'EndpointId' => ['description' => 'The endpoint ID of the instance.'."\n", 'type' => 'string', 'example' => 'ep-****', 'title' => ''],
'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', 'title' => ''],
'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****', 'title' => ''],
'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'rn-****13p6tum4289h', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'rm-u****', 'title' => ''],
'IpVersion' => ['description' => 'The version of the IP protocol. Valid values:'."\n"
."\n"
.'* **ipv4**'."\n"
.'* **ipv6**'."\n", 'type' => 'string', 'example' => 'ipv4', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-****105593277CAB', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => 'The RAM user account does not have the required permissions. Grant the account the required permissions.'],
['errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-05-09T12:13:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-22T03:44:49.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceEndpoints'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceEndpoints',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'NodeId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => '3397027', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'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', 'title' => ''],
'ZoneId' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', 'description' => ''],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current DB instance engine version does not support this operation.', 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHAConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceHAConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceIPArrayName' => ['description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'example' => 'rds_default', 'title' => ''],
'SecurityIPList' => ['description' => 'The IP addresses in the IP address whitelist.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX/24', 'title' => ''],
'SecurityIPType' => ['description' => 'The type of the IP address.'."\n", 'type' => 'string', 'example' => 'IPv4', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E2B6AF71-DC32-4055-B477-43B348798D10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidEndpointType.Format', 'errorMessage' => 'The specified EndpointType is invalid.', 'description' => 'The value of the EndpointType parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified OwnerAccount is invalid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'WhitelistNetType.Format', 'errorMessage' => 'The specified is WhitelistNetType not valid.', 'description' => ''],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-29T05:31:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIPArrayList'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceIPArrayList',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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,sd****B;172.16.xx.xx,sd****A', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '67CD4719-51E3-4A76-A38C-02F45FAE7E36', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-15T09:39:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:26:52.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIpHostname'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceIpHostname',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1****', 'title' => ''],
'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' => 'sys cpu使用率,sys cpu使用量 / cpu总量', 'title' => ''],
'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', 'title' => ''],
'GroupKey' => ['description' => 'The key of the group to which the enhanced monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage', 'title' => ''],
'GroupKeyType' => ['description' => 'The name of the group to which the enhanced monitoring metric belongs.'."\n", 'type' => 'string', 'example' => 'CPU使用率', 'title' => ''],
'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', 'title' => ''],
'MetricsKey' => ['description' => 'The key of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys.avg', 'title' => ''],
'MetricsKeyAlias' => ['description' => 'The alias of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => 'os.cpu_usage.sys', 'title' => ''],
'SortRule' => ['description' => 'The serial number of the enhanced monitoring metric.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Unit' => ['description' => 'The unit of the enhanced monitoring metric.'."\n", 'type' => 'string', 'example' => '%', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '318C3754-F6D0-54BB-A55C-23EAA04708B7', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of enhanced monitoring metrics that are enabled for the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidInstanceMetricsConfigs.NotFound', 'errorMessage' => 'The specified instance has no metrics configs', 'description' => 'The specified instance does not have performance metric configurations.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMetrics'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceMetrics',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Period' => ['description' => 'The monitoring frequency. Unit: seconds.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30829FD4-1A84-4C2A-A625-2EADECB95CA3', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMonitor'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceMonitor',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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' => 'test', 'default' => '1', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'ConnectionString' => ['description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6w****.mysql.rds.aliyuncs.com', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceType' => ['description' => 'The type of the instance. Valid values:'."\n"
."\n"
.'* **Master**: primary instance'."\n"
.'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', 'title' => ''],
'Role' => ['description' => 'A deprecated parameter.'."\n", 'type' => 'string', 'example' => '无', 'title' => ''],
'Weight' => ['description' => 'The weight of the instance.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'ExpiredTime' => ['description' => 'The remaining validity period of the instance in the classic network in hybrid access mode. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1209534', 'title' => ''],
'IPAddress' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Port' => ['description' => 'The port that is used to connect to the instance.'."\n", 'type' => 'string', 'example' => '3306', 'title' => ''],
'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', 'title' => ''],
'SecurityIPs' => ['description' => 'The IP address in the whitelist.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'VPCId' => ['description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90*****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '777C4593-8053-427B-99E2-105593277CAB', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, retry later.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'DB instance name not found.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'Illegal parameter', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'Readins.NotFound', 'errorMessage' => 'Readonly instance not found.', 'description' => ''],
['errorCode' => 'MissingRWSplistParam', 'errorMessage' => 'Custins is missing rw split param.', 'description' => 'The instance is missing a read/write split parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeDBInstanceNetInfo',
'description' => '### Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n"
.'* MariaDB'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-15T07:38:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-27T11:30:07.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-12-28T14:18:04.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-12-28T14:18:04.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceNetInfo',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'DescribeDBInstanceNetInfoForChannel' => [
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'Flag',
'in' => 'query',
'schema' => ['description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '无', 'default' => '0', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'ConnectionString' => ['description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6w****.mysql.rds.aliyuncs.com', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n"
."\n"
.'* **Master**: primary instance'."\n"
.'* **Readonly**: read-only instance'."\n", 'type' => 'string', 'example' => 'Master', 'title' => ''],
'Weight' => ['description' => 'The weight of the instance.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'IPAddress' => ['description' => 'The IP address of the instance.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Port' => ['description' => 'The port number of the instance.'."\n", 'type' => 'string', 'example' => '6379', 'title' => ''],
'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', 'title' => ''],
'SecurityIPs' => ['description' => 'The IP addresses that is contained in the IP address whitelist.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Upgradeable' => ['description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'Disabled', 'title' => ''],
'VPCId' => ['description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID of the instance.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''],
'expiredTime' => ['description' => 'The expiration time of the endpoint of the classic network type. Unit: seconds.'."\n", 'type' => 'string', 'example' => '5183779', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '61DF1F28-F409-50C0-B90A-CCE82D44****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'AccountLeastAssociateOneDB', 'errorMessage' => 'Retain at least one account in a DB.', 'description' => 'At least one authorized account must be retained for the database.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', 'description' => 'The operation failed. The RDS instance is not attached with read-only RDS instances.'],
['errorCode' => 'InvalidRwSplitNetType.NotFound', 'errorMessage' => 'The RwSplitNetType is not found.', 'description' => 'The operation failed. Create an RDS instance for which read/write splitting is enabled and try again.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeDBInstanceNetInfoForChannel',
'summary' => 'Queries all endpoints of an instance.',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n"
.'* MariaDB'."\n",
'changeSet' => [
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfoForChannel'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceNetInfoForChannel',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'DescribeDBInstancePerformance' => [
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' rm-uf6wjk5****', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL_NetworkTraffic', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-08T15:00Z', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2012-06-18T15:00Z', 'title' => ''],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => '339****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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.', 'type' => 'string', 'example' => '2012-06-19T15:00Z', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'PerformanceKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceKey' => [
'description' => 'Details of the performance metrics.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'MySQL_NetworkTraffic', 'title' => ''],
'Unit' => ['description' => 'The unit of the performance metrics.', 'type' => 'string', 'example' => 'KB', 'title' => ''],
'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.', 'type' => 'string', 'example' => 'recv_k&sent_k', 'title' => ''],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceValue' => [
'description' => 'The performance metric values.',
'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.', 'type' => 'string', 'example' => '2011-05-30T03:29:00Z', 'title' => ''],
'Value' => ['description' => 'The value of the performance metric.', 'type' => 'string', 'example' => '5.35&6.74', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A5409D02-D661-4BF3-8F3D-0A814D0574E7', 'title' => ''],
'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.', 'type' => 'string', 'example' => '2012-06-10T15:00Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidTargetEntity.Malformed', 'errorMessage' => 'the specified target entity is not found.', 'description' => 'The queried entity does not exist'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
408 => [
['errorCode' => 'InvalidOthers.Timeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', 'description' => 'Request timed out, please try again or narrow the time range'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeDBInstancePerformance',
'summary' => 'Queries the performance metrics of an instance.',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'- MySQL'."\n"
."\n"
.'- PostgreSQL'."\n"
."\n"
.'- SQL Server'."\n"
."\n"
.'- MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-09-30T06:35:17.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePerformance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancePerformance',
'authLevel' => 'operate',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
],
'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-uf6wjk5******', 'title' => ''],
],
[
'name' => 'AliUid',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22973492**********', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '22973492**********', 'title' => ''],
'Bid' => ['description' => '* China site: 26842'."\n"
.'* International site: 26888'."\n", 'type' => 'string', 'example' => '26888', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID. You can call the [DescribeDBInstances](~~26232~~) operation to query the instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5******', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5******', 'title' => ''],
'DBType' => ['description' => 'The type of the database engine. Valid values:'."\n"
."\n"
.'* **MySQL**'."\n"
.'* **PostgreSQL**'."\n"
.'* **Oracle**'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'IsActivity' => ['description' => 'The activity information about the instance. For more information, see [Instance activities](~~2391834~~).'."\n", 'type' => 'string', 'example' => '1(表示目标实例未参加任何促销活动)', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '94CB8D93-017A-5AE7-A118-6E0F89D93C0A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'description' => '该接口已停止维护:**接口仍可以正常调用,但阿里云不再维护该接口**。',
'changeSet' => [
['createdAt' => '2022-06-20T11:46:03.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePromoteActivity'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancePromoteActivity',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
],
'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\\"}', 'title' => ''],
'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\\"}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34', 'title' => ''],
'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\\"}', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceProxyConfiguration'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceProxyConfiguration',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeDBInstanceReplication' => [
'summary' => 'This API returns the status and configuration of native replication instances.',
'methods' => ['get', 'post'],
'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 list of regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the details of an instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmx****', 'required' => false, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Details about the response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2'],
'ExternalReplication' => ['description' => 'Indicates whether native replication is enabled. Valid values:'."\n"
."\n"
.'- **ON**: Enabled.'."\n"
."\n"
.'- **OFF**: Disabled.', 'type' => 'string', 'example' => 'ON', 'title' => ''],
'ReplicationSource' => ['description' => 'The replication source for native replication.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
'ReplicationState' => ['description' => 'The current replication state. Valid values:'."\n"
."\n"
.'- **Running**'."\n"
."\n"
.'- **Connecting**'."\n"
."\n"
.'- **Stopped**'."\n"
."\n"
.'- **Error**', 'type' => 'string', 'example' => 'Stopped', 'title' => ''],
'ReplicationDelay' => ['description' => 'The current replication delay, in seconds.', 'type' => 'string', 'example' => '0', 'title' => ''],
'ReplicationErrorMessage' => ['description' => 'The replication error message.', 'type' => 'string', 'example' => 'Got fatal error 1236 from master when reading data from binary log...', 'title' => ''],
'ReplicationIp' => ['description' => 'The IP address of the replica node.', 'type' => 'string', 'example' => '192.168.10.x', 'title' => ''],
'ReplicationPort' => ['description' => 'The port of the replica node.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'GtidExecuted' => ['description' => 'The executed Global Transaction Identifier (GTID).', 'type' => 'string', 'example' => 'bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567', 'title' => ''],
'ImportStatus' => ['description' => 'The import status. This parameter indicates whether the full data of the source instance is successfully imported into the replica instance.', 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''],
'SlaveStatusList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SlaveIoRunning' => ['description' => 'Indicates whether the I/O thread is running. Valid values: `Yes` and `No`.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
'SlaveSqlRunning' => ['description' => 'Indicates whether the SQL thread is running. Valid values: `Yes` and `No`.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
'SecondsBehindMaster' => ['description' => 'The number of seconds that the replica instance lags behind the source instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'SlaveIoState' => ['description' => 'The state of the I/O thread.', 'type' => 'string', 'example' => 'Waiting for master to send event', 'title' => ''],
'SlaveSqlRunningState' => ['description' => 'The state of the SQL thread.', 'type' => 'string', 'example' => 'Slave has read all relay log; waiting for more updates', 'title' => ''],
'ExecutedGtidSet' => ['description' => 'The GTID set that has been executed by the replica instance.', 'type' => 'string', 'example' => 'bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567', 'title' => ''],
'MasterHost' => ['description' => 'The hostname or IP address of the source instance.', 'type' => 'string', 'example' => '192.168.10.100', 'title' => ''],
'MasterUser' => ['description' => 'The username that is used to connect to the source instance for replication.', 'type' => 'string', 'example' => 'repl_user', 'title' => ''],
'MasterUuid' => ['description' => 'The UUID of the source instance.', 'type' => 'string', 'example' => 'bd2a34b9-8b8d-11ef-8917-00163e1298b9', 'title' => ''],
'LastErrno' => ['description' => 'The number of the last error. A value of `0` indicates that no error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'LastSqlErrno' => ['description' => 'The number of the last error that occurred on the SQL thread. A value of `0` indicates that no error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'LastIoErrno' => ['description' => 'The number of the last error that occurred on the I/O thread. A value of `0` indicates that no error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'LastSqlError' => ['description' => 'The message of the last error that occurred on the SQL thread.', 'type' => 'string', 'example' => '', 'title' => ''],
'LastIoError' => ['description' => 'The message of the last error that occurred on the I/O thread.', 'type' => 'string', 'example' => '', 'title' => ''],
'ChannelName' => ['description' => 'The name of the replication channel.', 'type' => 'string', 'example' => 'my_test_channel', 'title' => ''],
'ReplicateDoDb' => ['description' => 'A comma-separated list of databases that you want to replicate.', 'type' => 'string', 'example' => 'test_db,test_db_1', 'title' => ''],
'ReplicateIgnoreDb' => ['description' => 'A comma-separated list of databases that you want to ignore during replication.', 'type' => 'string', 'example' => 'information_schema,performance_schema', 'title' => ''],
'ReplicateDoTable' => ['description' => 'A comma-separated list of tables that you want to replicate.', 'type' => 'string', 'example' => 'test_table,test_table_1', 'title' => ''],
'ReplicateIgnoreTable' => ['description' => 'A comma-separated list of tables that you want to ignore during replication.', 'type' => 'string', 'example' => 'temp_table,temp_table_1', 'title' => ''],
'ReplicateWildDoTable' => ['description' => 'A comma-separated list of table patterns that you want to replicate. This parameter supports wildcards.', 'type' => 'string', 'example' => 'test_table.%', 'title' => ''],
'ReplicateWildIgnoreTable' => ['description' => 'A comma-separated list of table patterns that you want to ignore during replication. This parameter supports wildcards.', 'type' => 'string', 'example' => 'temp_table.%', 'title' => ''],
],
'title' => '',
'description' => '',
'example' => '',
],
'example' => '[{"SlaveIoRunning": "Yes", "SlaveSqlRunning": "Yes", "SecondsBehindMaster": 0, "SlaveIoState": "Waiting for master to send event", "SlaveSqlRunningState": "Slave has read all relay log; waiting for more updates", "ExecutedGtidSet": "bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567", "MasterHost": "192.168.10.100", "MasterUser": "repl_user", "MasterUuid": "bd2a34b9-8b8d-11ef-8917-00163e1298b9", "LastErrno": 0, "LastSqlErrno": 0, "LastIoErrno": 0, "LastSqlError": "", "LastIoError": "", "ChannelName": "my_test_channel", "ReplicateDoDb": "test_db,test_db_1", "ReplicateIgnoreDb": "information_schema,performance_schema", "ReplicateDoTable": "test_table,test_table_1", "ReplicateIgnoreTable": "temp_table,temp_table_1", "ReplicateWildDoTable": "test_table.%", "ReplicateWildIgnoreTable": "temp_table.%"}]',
'title' => '',
'description' => 'The details of the replication status for each replica instance.',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidReplicationChannel.NotFound', 'errorMessage' => 'Specified replication channel does not exist.', 'description' => 'Specified replication channel does not exist.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query Instance Replication Status',
'description' => '### Applicable engine'."\n"
."\n"
.'RDS MySQL'."\n"
."\n"
.'### Related feature documentation'."\n"
."\n"
.'>Before calling this API, read the feature documentation to fully understand its prerequisites and effects.>'."\n"
.'[RDS MySQL native replication instance](~~2856487~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceReplication'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceReplication',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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 \\"SlaveStatusList\\": [\\n {\\n \\"SlaveIoRunning\\": \\"Yes\\",\\n \\"SlaveSqlRunning\\": \\"Yes\\",\\n \\"SecondsBehindMaster\\": 0,\\n \\"SlaveIoState\\": \\"Waiting for master to send event\\",\\n \\"SlaveSqlRunningState\\": \\"Slave has read all relay log; waiting for more updates\\",\\n \\"ExecutedGtidSet\\": \\"bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567\\",\\n \\"MasterHost\\": \\"192.168.10.100\\",\\n \\"MasterUser\\": \\"repl_user\\",\\n \\"MasterUuid\\": \\"bd2a34b9-8b8d-11ef-8917-00163e1298b9\\",\\n \\"LastErrno\\": 0,\\n \\"LastSqlErrno\\": 0,\\n \\"LastIoErrno\\": 0,\\n \\"LastSqlError\\": \\"\\",\\n \\"LastIoError\\": \\"\\",\\n \\"ChannelName\\": \\"my_test_channel\\",\\n \\"ReplicateDoDb\\": \\"test_db,test_db_1\\",\\n \\"ReplicateIgnoreDb\\": \\"information_schema,performance_schema\\",\\n \\"ReplicateDoTable\\": \\"test_table,test_table_1\\",\\n \\"ReplicateIgnoreTable\\": \\"temp_table,temp_table_1\\",\\n \\"ReplicateWildDoTable\\": \\"test_table.%\\",\\n \\"ReplicateWildIgnoreTable\\": \\"temp_table.%\\"\\n }\\n ]\\n}","type":"json"}]',
],
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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-----', 'title' => ''],
'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' => '-', 'title' => ''],
'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-----', 'title' => ''],
'ConnectionString' => ['description' => 'The endpoint that is protected by SSL encryption.'."\n", 'type' => 'string', 'example' => 'rm-bp162dfr55g47****.mysql.rds.aliyuncs.com', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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.', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7705151C-E242-55AF-9929-2A3C39D979D2', 'title' => ''],
'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', 'title' => ''],
'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' => '-', 'title' => ''],
'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' => '-', 'title' => ''],
'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' => '-', 'title' => ''],
'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', 'title' => ''],
'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' => '2025-06-16T08:16:43Z', 'title' => ''],
'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' => '-', 'title' => ''],
'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-----', 'title' => ''],
'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-----', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvaildEngineInRegion.ValueNotSupported', 'errorMessage' => 'The engine is not supported in the region.', 'description' => 'The database engine version is invalid.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'Specified Status is not valid.', 'description' => ''],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => 'The current instance type does not support this operation.'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'ConnectionStringLengthExceeded', 'errorMessage' => 'Connection String is too long.', 'description' => 'The endpoint is exceedingly long. Modify the endpoint and try again.'],
['errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['errorCode' => 'EnabledSSLNotSupport', 'errorMessage' => 'Specified region does not support enable ssl.', 'description' => 'SSL encryption is not supported in the region.'],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-25T13:59:57.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-05T05:19:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-20T09:40:34.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceSSL',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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******', 'title' => ''],
],
],
'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', 'title' => ''],
'Data' => ['description' => 'The details of the security group rule.'."\n", 'type' => 'string', 'example' => '{"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******\\"}"}', 'title' => ''],
'Message' => ['description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6BFF4136-10B9-130B-BF8E-D3504BCE4F43'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSecurityGroupRule'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceSecurityGroupRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DescribeDBInstanceSwitchLog' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '2026-04-01T00:00Z', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '2026-04-02T00:00Z', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['type' => 'string', 'format' => 'byte', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => '', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Item' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AffectedSessions' => ['description' => '', 'type' => 'string', 'example' => '-1', 'title' => ''],
'HAStatus' => ['description' => '', 'type' => 'string', 'example' => '无', 'title' => ''],
'SwitchCauseCode' => ['description' => '', 'type' => 'string', 'example' => 'Platform.Ha.AuroraService.ManualOperations', 'title' => ''],
'SwitchCauseDetail' => ['type' => 'string', 'description' => '', 'example' => 'Platform.Ha.HASwitchover', 'title' => ''],
'SwitchFinishTime' => ['description' => '', 'type' => 'string', 'example' => '2026-04-01T00:30:05Z', 'title' => ''],
'SwitchId' => ['description' => '', 'type' => 'string', 'example' => 'a0fbf378-****-****-****-d80510ce9283', 'title' => ''],
'SwitchStartTime' => ['description' => '', 'type' => 'string', 'example' => '2026-04-01T00:30:00Z', 'title' => ''],
'TotalSessions' => ['description' => '', 'type' => 'string', 'example' => '100', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'D1CA494F-CC13-4EB6-8C4D-5352EE4045BD', 'title' => ''],
'TotalRecordCount' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeDBInstanceSwitchLog',
'summary' => '',
'description' => '该接口用于查看实例的主备切换日志,适用于MySQL高可用版实例、MySQL三节点企业版实例、SQL Server实例、PostgreSQL实例、PPAS实例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceSwitchLog',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DBInstanceName\\": \\"rm-uf6wjk5****\\",\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"AffectedSessions\\": \\"-1\\",\\n \\"HAStatus\\": \\"无\\",\\n \\"SwitchCauseCode\\": \\"Platform.Ha.AuroraService.ManualOperations\\",\\n \\"SwitchCauseDetail\\": \\"Platform.Ha.HASwitchover\\",\\n \\"SwitchFinishTime\\": \\"2026-04-01T00:30:05Z\\",\\n \\"SwitchId\\": \\"a0fbf378-****-****-****-d80510ce9283\\",\\n \\"SwitchStartTime\\": \\"2026-04-01T00:30:00Z\\",\\n \\"TotalSessions\\": \\"100\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"RequestId\\": \\"D1CA494F-CC13-4EB6-8C4D-5352EE4045BD\\",\\n \\"TotalRecordCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t\\n\\t1\\n\\t5\\n\\tD1CA494F-CC13-4EB6-8C4D-5352EE4045BD\\n\\t60\\n\\trm-m5el220b25im05g7g\\n\\t\\n","errorExample":""}]',
'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-uf6wjk5****', 'title' => ''],
],
],
'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', 'title' => ''],
'TDEStatus' => ['description' => 'The TDE status at the database level. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2', 'title' => ''],
'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', 'title' => ''],
'TDEStatus' => ['description' => 'The TDE status of the instance. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'EncryptionKey' => ['type' => 'string', 'example' => 'key-szz644a355asjcuilll4u', 'description' => 'The ID of the custom key.'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Connect.Timeout', 'errorMessage' => 'Service can not connect to instance temporarily.', 'description' => 'The operation failed. The RDS instance cannot be connected. Please try again later.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', 'description' => ''],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
['errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', 'description' => 'The size of the database exceeds the maximum size that is allowed.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', 'description' => 'The operation failed. The instance name cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-12-18T09:57:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-11-13T12:49:30.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-11-13T02:31:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-30T10:03:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-31T12:37:07.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstanceTDE',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeDBInstances' => [
'summary' => 'This API retrieves a list of RDS 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' => 'A client-generated token to ensure request idempotence. It must be unique for each request, up to 64 characters in length, and contain only ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. You do not need to specify it.', 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The database engine. Valid values:'."\n"
."\n"
.'- **MySQL**'."\n"
."\n"
.'- **SQLServer**'."\n"
."\n"
.'- **PostgreSQL**'."\n"
."\n"
.'- **MariaDB**'."\n"
."\n"
.'If unspecified, instances of all engines are returned.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'name' => 'DBInstanceStatus',
'in' => 'query',
'schema' => ['description' => 'The instance status. For more information, see [Instance status table](~~26315~~).', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''],
],
[
'name' => 'Expired',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the instance has expired. Valid values:'."\n"
."\n"
.'- **True**: The instance has expired.'."\n"
."\n"
.'- **False**: The instance has not expired.', 'type' => 'string', 'required' => false, 'default' => 'False', 'example' => 'True', 'title' => ''],
],
[
'name' => 'SearchKey',
'in' => 'query',
'schema' => ['description' => 'A keyword for a fuzzy search on instance IDs and descriptions.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6w', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'DBInstanceType',
'in' => 'query',
'schema' => ['description' => 'The instance type. Valid values:'."\n"
."\n"
.'- **Primary**: A primary instance'."\n"
."\n"
.'- **Readonly**: A read-only instance'."\n"
."\n"
.'- **Guard**: A disaster recovery instance'."\n"
."\n"
.'- **Temp**: A temporary instance'."\n"
."\n"
.'If unspecified, instances of all types are returned.', 'type' => 'string', 'required' => false, 'example' => 'Primary', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID. You can call the DescribeRegions operation to query the latest list of regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values: **1** to **100**.'."\n"
."\n"
.'Default: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '30', 'example' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number to return. The value must be an integer greater than 0.'."\n"
."\n"
.'Default: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '21474836', 'minimum' => '0', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'InstanceNetworkType',
'in' => 'query',
'schema' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **VPC**: An instance in a VPC'."\n"
."\n"
.'- **Classic**: An instance in the classic network'."\n"
."\n"
.'If unspecified, instances of both network types are returned.', 'type' => 'string', 'required' => false, 'example' => 'Classic', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The instance class. For more information, see [Instance class table](~~26312~~).', 'type' => 'string', 'required' => false, 'example' => 'rds.mys2.small', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version.', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The billing method. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription', 'type' => 'string', 'required' => false, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'ConnectionMode',
'in' => 'query',
'schema' => ['description' => 'The connection mode of the instance. Valid values:'."\n"
."\n"
.'- **Standard**: standard connection mode'."\n"
."\n"
.'- **Safe**: database proxy mode'."\n"
."\n"
.'If unspecified, instances in all connection modes are returned.', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'The tags to filter instances. You can specify up to five tags as key-value pairs in a JSON string. An instance is returned if it has any of the specified tags.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupId',
'in' => 'query',
'schema' => ['description' => 'The dedicated cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9****', 'title' => ''],
],
[
'name' => 'DedicatedHostId',
'in' => 'query',
'schema' => ['description' => 'The ID of the host in the dedicated cluster.', 'type' => 'string', 'required' => false, 'example' => 'i-bp****', 'title' => ''],
],
[
'name' => 'InstanceLevel',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return information about the instance edition, which corresponds to the `Category` parameter. Valid values:'."\n"
."\n"
.'- **0**: The instance edition is not returned.'."\n"
."\n"
.'- **1**: The instance edition is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'QueryAutoRenewal',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved. You do not need to specify it.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'test', 'title' => ''],
],
[
'name' => 'ConnectionString',
'in' => 'query',
'schema' => ['description' => 'The instance endpoint. If specified, this operation returns only the instance associated with this endpoint.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'A pagination token from a previous call to the **DescribeDBInstances** operation. To retrieve the next page of results, specify the **NextToken** value from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'o7PORW5o2TJg****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: **1** to **100**.'."\n"
."\n"
.'Default: **30**.'."\n"
."\n"
.'> If you specify this parameter, the `PageSize` and `PageNumber` parameters are ignored.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => 'A JSON string that contains filter conditions for the query.', 'type' => 'string', 'required' => false, 'example' => '{"babelfishEnabled":"true"}', 'title' => ''],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **Basic**: Basic edition'."\n"
."\n"
.'- **HighAvailability**: High-availability edition'."\n"
."\n"
.'- **cluster**: Cluster edition'."\n"
."\n"
.'- **serverless\\_basic**: Serverless', 'type' => 'string', 'required' => false, 'example' => 'cluster', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The details of the response parameters.',
'type' => 'object',
'properties' => [
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBInstance' => [
'description' => 'An array of instance details.',
'type' => 'array',
'items' => [
'description' => 'The instance details.',
'type' => 'object',
'properties' => [
'BpeEnabled' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '0', 'title' => ''],
'BurstingEnabled' => ['description' => 'Indicates whether the I/O bursting feature is enabled. Valid values:'."\n"
."\n"
.'- **true**: Enabled'."\n"
."\n"
.'- **false**: Disabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Category' => ['description' => 'The instance category. Valid values:'."\n"
."\n"
.'- **Basic**: Basic Edition'."\n"
."\n"
.'- **HighAvailability**: High-availability Edition'."\n"
."\n"
.'- **Finance**: Enterprise Edition'."\n"
."\n"
.'> This parameter is returned only when the `InstanceLevel` parameter is set to `1`.', 'type' => 'string', 'example' => 'Basic', 'title' => ''],
'IsAnalyticReadOnlyIns' => ['description' => 'Indicates whether the instance is a [MySQL DuckDB analytic instance](~~2950002~~). Valid values:'."\n"
."\n"
.'- **true**'."\n"
."\n"
.'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ConnectionMode' => ['description' => 'The connection mode of the instance. Valid values:'."\n"
."\n"
.'- **Standard**: standard connection mode'."\n"
."\n"
.'- **Safe**: database proxy mode', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
'ConnectionString' => ['description' => 'The endpoint of the instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
'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.', 'type' => 'string', 'example' => '2018-11-05T11:26:02Z', 'title' => ''],
'DBInstanceCPU' => ['description' => 'The number of CPU cores.'."\n"
."\n"
.'> This parameter is returned only when the InstanceLevel parameter is set to 1.', 'type' => 'string', 'example' => '2', 'title' => ''],
'DBInstanceClass' => ['description' => 'The instance type. For more information, see [Primary ApsaraDB RDS for MySQL instance types](~~26312~~).', 'type' => 'string', 'example' => 'rds.mys2.small', 'title' => ''],
'DBInstanceDescription' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'testdb', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceMemory' => ['description' => 'The memory capacity of the node. Unit: MB.'."\n"
."\n"
.'> This parameter is returned only when the InstanceLevel parameter is set to 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '4096', 'title' => ''],
'DBInstanceNetType' => ['description' => 'The network connection type of the instance. Valid values:'."\n"
."\n"
.'- **Internet**'."\n"
."\n"
.'- **Intranet**', 'type' => 'string', 'example' => 'Internet', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance state. For more information, see [Instance states](~~26315~~).', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'DBInstanceStorageType' => ['description' => 'The storage type of the instance.', 'type' => 'string', 'example' => 'ModuleList.4.ModuleCode', 'title' => ''],
'DBInstanceType' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **Primary**: primary instance'."\n"
."\n"
.'- **Readonly**: read-only instance'."\n"
."\n"
.'- **Guard**: disaster recovery instance'."\n"
."\n"
.'- **Temp**: temporary instance', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'DedicatedHostGroupId' => ['description' => 'The dedicated cluster ID.', 'type' => 'string', 'example' => 'dhg-7a9****', 'title' => ''],
'DedicatedHostGroupName' => ['description' => 'The name of the dedicated cluster.', 'type' => 'string', 'example' => 'testhostgroup', 'title' => ''],
'DedicatedHostIdForLog' => ['description' => 'The ID of the host on which the log node resides.', 'type' => 'string', 'example' => 'dh-bp****', 'title' => ''],
'DedicatedHostIdForMaster' => ['description' => 'The ID of the host on which the primary node resides.', 'type' => 'string', 'example' => 'dh-bp****', 'title' => ''],
'DedicatedHostIdForSlave' => ['description' => 'The ID of the host on which the secondary node resides.', 'type' => 'string', 'example' => 'dh-bp****', 'title' => ''],
'DedicatedHostNameForLog' => ['description' => 'The name of the host on which the log node resides.', 'type' => 'string', 'example' => 'testlog', 'title' => ''],
'DedicatedHostNameForMaster' => ['description' => 'The name of the host on which the primary node resides.', 'type' => 'string', 'example' => 'testmaster', 'title' => ''],
'DedicatedHostNameForSlave' => ['description' => 'The name of the host on which the secondary node resides.', 'type' => 'string', 'example' => 'testslave', 'title' => ''],
'DedicatedHostZoneIdForLog' => ['description' => 'The zone ID of the host on which the log node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
'DedicatedHostZoneIdForMaster' => ['description' => 'The zone ID of the host on which the primary node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-c', 'title' => ''],
'DedicatedHostZoneIdForSlave' => ['description' => 'The zone ID of the host on which the secondary node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-d', 'title' => ''],
'DeletionProtection' => ['description' => 'Indicates whether the release protection feature is enabled. Valid values:'."\n"
."\n"
.'- **true**: The feature is enabled.'."\n"
."\n"
.'- **false**: The feature is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'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.', 'type' => 'string', 'example' => '2018-11-05T11:26:02Z', 'title' => ''],
'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time of the subscription 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 do not expire.', 'type' => 'string', 'example' => '2019-02-27T16:00:00Z', 'title' => ''],
'GeneralGroupName' => ['description' => 'The name of the group to which the general-purpose ApsaraDB RDS for MySQL instance in a dedicated cluster belongs.', 'type' => 'string', 'example' => 'TestGroup', 'title' => ''],
'GuardDBInstanceId' => ['description' => 'If the instance is a primary instance and has a disaster recovery instance, this parameter is the ID of the disaster recovery instance.', 'type' => 'string', 'example' => 'rm-uf64zsu****', 'title' => ''],
'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **Classic**'."\n"
."\n"
.'- **VPC**', 'type' => 'string', 'example' => 'Classic', 'title' => ''],
'IoAccelerationEnabled' => ['description' => 'Indicates whether I/O acceleration is enabled. Valid values:'."\n"
."\n"
.'- **1**: enabled'."\n"
."\n"
.'- **0**: disabled', 'type' => 'string', 'example' => '0', 'title' => ''],
'LockMode' => ['description' => 'The lock state of the instance. Valid values:'."\n"
."\n"
.'- **Unlock**: The instance is not locked.'."\n"
."\n"
.'- **ManualLock**: The instance is manually locked.'."\n"
."\n"
.'- **LockByExpiration**: The instance is automatically locked due to expiration.'."\n"
."\n"
.'- **LockByRestoration**: The instance is automatically locked before a rollback.'."\n"
."\n"
.'- **LockByDiskQuota**: The instance is automatically locked because its storage is full.'."\n"
."\n"
.'- **Released**: The instance is released. After an instance is released, it cannot be unlocked. You can only restore the data of the instance to a new instance.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''],
'LockReason' => ['description' => 'The reason why the instance was locked.', 'type' => 'string', 'example' => 'instance_expired', 'title' => ''],
'MasterInstanceId' => ['description' => 'The ID of the primary instance. If this parameter is null, the instance is a primary instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'MutriORsignle' => ['description' => 'Indicates whether the instance is deployed in multiple zones. Valid values:'."\n"
."\n"
.'- **true**'."\n"
."\n"
.'- **false**'."\n"
."\n"
.'> A multiple-zone deployment is a deployment in which the zone ID contains MAZ. For example, the zone ID is `cn-hangzhou-MAZ10(h,i)`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PayType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- **Postpaid**: pay-as-you-go'."\n"
."\n"
.'- **Prepaid**: subscription', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'ReadOnlyDBInstanceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ReadOnlyDBInstanceId' => [
'description' => 'The IDs of the read-only instances that are attached to the primary instance.',
'type' => 'array',
'items' => [
'description' => 'The details of a read-only instance.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The read-only instance ID.', 'type' => 'string', 'example' => 'rr-uf6wjk5****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'Details about the read replicas of the instance.',
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'SwitchWeight' => ['description' => 'Indicates whether the general-purpose ApsaraDB RDS for MySQL instance in a dedicated cluster supports high-availability weight-based switchovers. Valid values:'."\n"
."\n"
.'- **100**: Supported'."\n"
."\n"
.'- **0**: Not supported', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'TempDBInstanceId' => ['description' => 'If the instance is a primary instance and has a temporary instance, this parameter is the ID of the temporary instance.', 'type' => 'string', 'example' => 'rm-uf64zsu****', 'title' => ''],
'Tips' => ['description' => 'The exception message for the general-purpose ApsaraDB RDS for MySQL instance in a dedicated cluster.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'TipsLevel' => ['description' => 'The severity of the exception that is detected on the general-purpose ApsaraDB RDS for MySQL instance in a dedicated cluster. Valid values:'."\n"
."\n"
.'- **1**: The instance is normal.'."\n"
."\n"
.'- **2**: The instance type of the read-only instance is different from the instance type of the primary instance. This may affect the availability. You can change the instance type based on your business requirements.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
'VpcCloudInstanceId' => ['description' => 'The VPC instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90****', 'title' => ''],
'VpcName' => ['description' => 'The VPC name.', 'type' => 'string', 'example' => 'test-huadong', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'BlueGreenDeploymentName' => ['description' => 'Reserved parameter.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'BlueInstanceName' => ['description' => 'Reserved parameter.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'GreenInstanceName' => ['description' => 'Reserved parameter.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values:'."\n"
."\n"
.'- **true**: Auto-renewal is enabled.'."\n"
."\n"
.'- **false**: Auto-renewal is disabled.'."\n"
."\n"
.'> This parameter is returned only when `PayType` is set to `Prepaid`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ColdDataEnabled' => ['description' => 'Reserved parameter.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'IsAnalyticIns' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the **NextToken** parameter is not returned, no more results are available.', 'type' => 'string', 'example' => 'o7PORW5o2TJg****', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n"
."\n"
.'> If you specify the **MaxResults** or **NextToken** parameter, this parameter is not returned. The value **1** is silently used for this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of instances on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n"
."\n"
.'> If you specify the **MaxResults** or **NextToken** parameter, this parameter is not returned. The number of entries on the current page is silently used for this parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid.NextToken', 'errorMessage' => 'The parameter NextToken is invalid.', 'description' => 'The specified NextToken is invalid.'],
['errorCode' => 'InvalidDBInstanceType.ValueNotSupport', 'errorMessage' => 'The specified parameter DBInstanceType is not valid.', 'description' => ''],
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'TimeoutRetryLater', 'errorMessage' => 'Timeout, Please retry later.', 'description' => ''],
['errorCode' => 'InvalidExpired.Format', 'errorMessage' => 'The instance expiration status parameter is incorrect.', 'description' => 'The parameter that specifies the instance expiration status is invalid.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'Abs.ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', 'description' => 'The specified image has expired or has been deleted.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Query Instance List',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'- RDS SQL Server'."\n"
."\n"
.'- RDS MariaDB',
'requestParamsDescription' => 'This API supports the following two methods for paginating results:'."\n"
."\n"
.'- Method 1: Use the **MaxResults** parameter to set the number of records per page and the **NextToken** parameter to retrieve subsequent pages. The value for **NextToken** is the **NextToken** returned from the previous call to the **DescribeDBInstances** API.'."\n"
."\n"
.'> For the first request in a paginated query, set only the **MaxResults** parameter. The API returns the first page of data along with a **NextToken** value.'."\n"
."\n"
.'- Method 2: Use the **PageSize** parameter to set the number of records per page, and the **PageNumber** parameter to request a specific page.'."\n"
."\n"
.'> You can use only one of these methods at a time. For better query performance with large result sets, use Method 1.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-05-07T13:14:44.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-08-15T08:50:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-02T14:02:32.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-04-01T13:11:41.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-01-04T11:54:28.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-05-26T08:09:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2023-05-15T08:28:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-11T08:39:57.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-01T02:53:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-14T14:01:44.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-10-11T11:42:41.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '6000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstances'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstances',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeDBInstancesAsCsv' => [
'summary' => 'This API retrieves a list of instances. It is now deprecated.',
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the `DescribeDBInstances` operation to query the details of all instances in a specified region.', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5**** ', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'name' => 'CachedAsync',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'name' => 'ExportKey',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The details of the response parameters.',
'type' => 'object',
'properties' => [
'Items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBInstanceAttribute' => [
'description' => 'An array that consists of the attributes of the instance.',
'type' => 'array',
'items' => [
'description' => 'The details of the instance attributes.',
'type' => 'object',
'properties' => [
'AccountMaxQuantity' => ['description' => 'The maximum number of accounts that can be created on the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''],
'AccountType' => ['description' => 'The account type.', 'type' => 'string', 'example' => 'super', 'title' => ''],
'AvailabilityValue' => ['description' => 'The availability of the instance, in percent (%).', 'type' => 'string', 'example' => '100', 'title' => ''],
'Category' => ['description' => 'The instance category.', 'type' => 'string', 'example' => '0', 'title' => ''],
'ConnectionMode' => ['description' => 'The connection mode of the instance. Valid values:'."\n"
."\n"
.'- **Performance**: Standard access mode.'."\n"
."\n"
.'- **Safety**: Secure access mode.', 'type' => 'string', 'example' => 'Performance', 'title' => ''],
'ConnectionString' => ['description' => 'The internal connection string.', 'type' => 'string', 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
'CreationTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2011-05-30T12:11:04Z', 'title' => ''],
'DBInstanceCPU' => ['description' => 'The number of vCPUs for the instance.', 'type' => 'string', 'example' => '2', 'title' => ''],
'DBInstanceClass' => ['description' => 'The instance class.', 'type' => 'string', 'example' => 'rds.mys2.small', 'title' => ''],
'DBInstanceClassType' => ['description' => 'The instance class family.', 'type' => 'string', 'example' => 's', 'title' => ''],
'DBInstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '0', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceMemory' => ['description' => 'The memory capacity of the instance, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''],
'DBInstanceNetType' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'- **Internet**: The instance is accessible over the internet.'."\n"
."\n"
.'- **Intranet**: The instance is accessible over an internal network.', 'type' => 'string', 'example' => 'Internet', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
'DBInstanceStorage' => ['description' => 'The storage capacity of the instance, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'DBInstanceType' => ['description' => 'The instance type. Valid values:'."\n"
."\n"
.'- **Primary**: A primary instance that handles read and write operations.'."\n"
."\n"
.'- **ReadOnly**: A read-only instance that offloads read requests from the primary instance.'."\n"
."\n"
.'- **Guard**: A disaster recovery instance.'."\n"
."\n"
.'- **Temp**: A temporary instance used for tasks like data migration.', 'type' => 'string', 'example' => 'Primary', 'title' => ''],
'DBMaxQuantity' => ['description' => 'The maximum number of databases that you can create on the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '8.0', 'title' => ''],
'ExpireTime' => ['description' => 'The time when the instance expires. This parameter is returned only for subscription instances.', 'type' => 'string', 'example' => '2019-03-27T16:00:00Z', 'title' => ''],
'ExportKey' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'API', 'title' => ''],
'GuardDBInstanceId' => ['description' => 'The ID of the disaster recovery instance. This parameter is returned only when a disaster recovery instance is attached to the primary instance.', 'type' => 'string', 'example' => 'rm-uf64zsu****', 'title' => ''],
'IncrementSourceDBInstanceId' => ['description' => 'The ID of the primary instance. This parameter is returned for read-only instances and disaster recovery instances. It is not returned for primary instances.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'LockMode' => ['description' => 'The lock mode of the instance. Valid values:', 'type' => 'string', 'example' => 'Unlock', 'title' => ''],
'LockReason' => ['description' => 'The reason why the instance is locked.', 'type' => 'string', 'example' => 'instance_expired', 'title' => ''],
'MaintainTime' => ['description' => 'The maintenance window of the instance. The time is in UTC. The time displayed in the ApsaraDB RDS console is in the time zone of the instance.', 'type' => 'string', 'example' => '00:00Z-02:00Z', 'title' => ''],
'MasterInstanceId' => ['description' => 'The ID of the primary instance.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'MaxConnections' => ['description' => 'The maximum number of concurrent connections.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'MaxIOPS' => ['description' => 'The maximum IOPS of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''],
'PayType' => ['description' => 'The billing method of the instance. Valid values:', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''],
'Port' => ['description' => 'The port that is used to connect to the instance over an internal network.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'ReadDelayTime' => ['description' => 'The latency of data replication from the primary instance to the read-only instance. The unit is second. This parameter is returned only for read-only instances.', 'type' => 'string', 'example' => '0', 'title' => ''],
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'SecurityIPList' => ['description' => 'The IP address whitelist of the instance.', 'type' => 'string', 'example' => '42.XX.XX.XX', 'title' => ''],
'SlaveZones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'slaveRegion' => [
'description' => 'This parameter is deprecated.',
'type' => 'array',
'items' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'API', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'SupportUpgradeAccountType' => ['description' => 'Indicates whether the instance supports the privileged account type.', 'type' => 'string', 'example' => 'No', 'title' => ''],
'Tags' => ['description' => 'The tags of the instance.', 'type' => 'string', 'example' => '0', 'title' => ''],
'TempDBInstanceId' => ['description' => 'The ID of the temporary instance. This parameter is returned only when a temporary instance is attached to the primary instance.', 'type' => 'string', 'example' => 'rm-uf64zs****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID of the instance.', 'type' => 'string', 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID of the instance.', 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90**** ', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
'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)', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A444291**** ', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InstanceNames.Malformed', 'errorMessage' => 'instance number of Instance Names should be less than 3000', 'description' => 'The operation failed. The instance name must be less than 3,000 characters in length.'],
['errorCode' => '400', 'errorMessage' => 'Export all instances more than 6 times in an hour, please try 1 hour later.', 'description' => ''],
['errorCode' => 'ExportLimitExceeded', 'errorMessage' => 'Export all instances more than 6 times in an hour, please try 1 hour later.', 'description' => 'Export all instances more than 6 times in one hour, please try again after 1 hour.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'Export.InProcess', 'errorMessage' => 'There is already a task running, please try later', 'description' => 'A task is running. Please try again later.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => [
'substitutions' => ['Rds::2014-08-15::DescribeDBInstances'],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'DescribeDBInstancesAsCsv',
'description' => 'This API is deprecated. **While it remains callable, Alibaba Cloud no longer maintains it**. We recommend using the **DescribeDBInstances** API instead.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-28T11:21:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-20T10:15:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-08-11T03:15:10.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesAsCsv'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancesAsCsv',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to configure this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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"} ', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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' => 'testInstance', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxx', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of instances returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:07.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesByExpireTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancesByExpireTime',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxx', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'SortMethod',
'in' => 'query',
'schema' => ['description' => 'The sorting method.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'default' => 'ASC', 'title' => ''],
],
[
'name' => 'SortKey',
'in' => 'query',
'schema' => ['description' => 'The sorting basis.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CPU_Usage', 'default' => 'CPUUsage', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceDescription' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'DatabaseTest', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxx', 'title' => ''],
'DiskUsage' => ['description' => 'The disk usage of the instance in percentage.'."\n", 'type' => 'string', 'example' => '14.56', 'title' => ''],
'IOPSUsage' => ['description' => 'The IOPS usage of the instance in percentage.'."\n", 'type' => 'string', 'example' => '0.15', 'title' => ''],
'SessionUsage' => ['description' => 'The number of sessions.'."\n", 'type' => 'string', 'example' => '0.10', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '23907437-79B9-411A-9EE6-75A8F0F1C619', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '28', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-08-11T03:15:10.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesByPerformance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancesByPerformance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'description' => 'This operation is phased out.'."\n",
],
'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', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API ', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values: **1 to 100**.'."\n"
."\n"
.'Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '30', 'default' => '30', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-j6cjvqms29yxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-j6csw46bgrgkxxxxxxxxxx', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.7', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'CurrentInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the current instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceClass' => ['description' => 'The instance type of the instance. For more information, see [Instance types](~~26312~~).'."\n", 'type' => 'string', 'example' => 'mysql.n1.micro.1', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'title' => ''],
'DBInstanceNetType' => ['description' => 'The network connection type of the instance. Valid values:'."\n"
."\n"
.'* **Internet**'."\n"
.'* **Intranet**'."\n", 'type' => 'string', 'example' => 'Intranet', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'EngineVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '5.7', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'InsId' => ['description' => 'The ID of the instance role.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'InstanceNetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n"
."\n"
.'* **Classic**'."\n"
.'* **VPC**'."\n", 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'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', 'title' => ''],
'LockReason' => ['description' => 'The reason why the instance was locked.'."\n", 'type' => 'string', 'example' => 'instance_expired', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ReplicateId' => ['description' => 'None.'."\n", 'type' => 'string', 'example' => '无', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmyxxxxx', 'title' => ''],
'TempDBInstanceId' => ['description' => 'The ID of the temporary instance.'."\n", 'type' => 'string', 'example' => 'sub138xxxxx_rm-xxxxx', 'title' => ''],
'VSwitchId' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-uf6adz52c2pxxxxxxxxxx ', 'title' => ''],
'VpcCloudInstanceId' => ['description' => 'The ID of the instance in the VPC.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'title' => ''],
'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp1opxu1zkhxxxxxxxxxx', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceType.ValueNotSupport', 'errorMessage' => 'The specified parameter"DBInstanceType" is not valid.', 'description' => 'The operation failed. The instance type is invalid. Specify a valid instance type.'],
['errorCode' => 'ApiError', 'errorMessage' => 'API error.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-11T03:15:10.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesForClone'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBInstancesForClone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'MaxRecordsPerPage' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'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' => '5.7.38', 'title' => ''],
'Engine' => ['description' => 'The database engine that corresponds to the minor engine version.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version that corresponds to the minor engine version.'."\n", 'type' => 'string', 'example' => '5.7', 'title' => ''],
'ExpireDate' => ['description' => 'The expiration time of the minor engine version.'."\n", 'type' => 'string', 'example' => '20231213', 'title' => ''],
'ExpireStatus' => [
'title' => '',
'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', 'title' => ''],
'MinorVersion' => ['description' => 'The minor engine version.'."\n", 'type' => 'string', 'example' => 'rds_20220731', 'title' => ''],
'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', 'title' => ''],
'ReleaseNote' => ['description' => 'The URL of the release notes for the minor engine version.'."\n", 'type' => 'string', 'example' => 'https://example.com', 'title' => ''],
'ReleaseType' => ['description' => 'The release type. Valid values:'."\n"
."\n"
.'* **LTS**: a long-term version'."\n"
.'* **BETA**: a preview version'."\n", 'type' => 'string', 'example' => 'BETA', 'title' => ''],
'StatusDesc' => ['title' => '', '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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumbers' => ['description' => 'The page number returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MinorVersionAttr.NotFound', 'errorMessage' => 'Cannot find minor version attribute by given custins.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'MissingMinorVersionTag', 'errorMessage' => 'You must specify MinorVersionTag.', 'description' => ''],
['errorCode' => 'MissingParameter.Engine', 'errorMessage' => 'You must specify Engine.', 'description' => ''],
['errorCode' => 'MissingParameter.EngineVersion', 'errorMessage' => 'You must specify EngineVersion.', 'description' => ''],
['errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', 'description' => ''],
['errorCode' => 'MinorVersionTag.NotFound', 'errorMessage' => 'Minor version tags cannot be parsed by the instance.', 'description' => ''],
['errorCode' => 'InvalidVersion', 'errorMessage' => 'current version not support operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidInstanceStorageType.NotFound', 'errorMessage' => 'The specified DBInstanceStorageType is not found.', 'description' => 'You must specify the InstanceStorageType parameter.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-01-09T13:03:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-07T07:54:00.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-06T11:32:38.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T07:33:22.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBMiniEngineVersions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBMiniEngineVersions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDBProxy' => [
'summary' => 'This API is used to query the PolarProxy settings of an 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", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBProxyInstanceMinorVersions' => [
'itemNode' => true,
'description' => '',
'type' => 'object',
'properties' => [
'DBProxyInstanceMinorVersions' => [
'description' => 'The collection of minor versions to which the proxy instance can be upgraded. ',
'type' => 'array',
'items' => ['description' => 'Upgradeable versions for the proxy.', 'type' => 'string', 'example' => '2.25.9_20251028', 'title' => ''],
'example' => '2.25.9',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'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',
'title' => '',
],
'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',
'title' => '',
],
'DBProxyConnectStringPort' => ['description' => 'The port that is associated with the database proxy endpoint.'."\n", 'type' => 'string', 'example' => '3306', 'title' => ''],
'DBProxyEndpointId' => ['description' => 'The ID of the backend database proxy endpoint.'."\n", 'type' => 'string', 'example' => '20****', 'title' => ''],
'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****', 'title' => ''],
'DBProxyVpcId' => ['description' => 'The VPC of the database proxy.'."\n", 'type' => 'string', 'example' => 'vpc-uf6oobt****', 'title' => ''],
'DBProxyVpcInstanceId' => ['description' => 'The ID of the database proxy instance.'."\n", 'type' => 'string', 'example' => 'rm-bp145737x5****131161274792****', 'title' => ''],
'DBProxyVswitchId' => ['description' => 'The vSwitch of the database proxy.'."\n", 'type' => 'string', 'example' => 'vsw-uf6l0pic17****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DBProxyEngineType' => ['description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''],
'DBProxyInstanceCurrentMinorVersion' => ['description' => 'The version of the proxy instance.'."\n", 'type' => 'string', 'example' => '1.13.11', 'title' => ''],
'DBProxyInstanceLatestMinorVersion' => ['description' => 'The latest version that is available for the proxy instance.'."\n", 'type' => 'string', 'example' => '1.13.12', 'title' => ''],
'DBProxyInstanceName' => ['description' => 'The name of the proxy instance.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****', 'title' => ''],
'DBProxyInstanceNum' => ['description' => 'The number of proxies that are enabled on the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'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', 'title' => ''],
'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',
'title' => '',
],
'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',
'title' => '',
],
'DBProxyKindCode' => ['description' => 'An internal parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => '18', 'title' => ''],
'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', 'title' => ''],
'nodeId' => ['description' => 'The ID of the proxy node.'."\n", 'type' => 'string', 'example' => 'pn-xxxxxxx01', 'title' => ''],
'zoneId' => ['description' => 'The ID of the zone in which the node is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-c', 'title' => ''],
],
'description' => 'Details of the node list.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DBProxyPersistentConnectionStatus' => ['description' => 'The status of persistence connections. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n"
.'* **Unsupported**'."\n", 'type' => 'string', 'example' => 'Disabled', 'title' => ''],
'DBProxyServiceStatus' => [
'description' => 'The status of the database proxy.'."\n"
."\n"
.'* Shutdown: disabled'."\n"
.'* Startup: enabled'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Startup',
'title' => '',
],
'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', 'title' => ''],
'DbProxyEndpointName' => ['description' => 'The ID of the database proxy endpoint.'."\n", 'type' => 'string', 'example' => 'gos787jog2wk0ye1****', 'title' => ''],
'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',
'title' => '',
],
'DbProxyReadWriteMode' => [
'description' => 'The read and write attributes of the database proxy endpoint.'."\n"
."\n"
.'* ReadOnly'."\n"
.'* ReadWrite'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'ReadWrite',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '909A69EE-71C8-4417-A0B9-FF085407E1E3', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'RWSplitNetTypeNotExists', 'errorMessage' => 'Specified rw split net type is not eixsts.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'InvalidInstanceLevelExtraInfo', 'errorMessage' => 'Specified class code has error extra info.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Query PolarProxy details',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL',
'changeSet' => [
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-12T12:16:19.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-11-23T12:33:15.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-03-14T15:12:13.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-06-08T14:33:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'DescribeDBProxyEndpoint' => [
'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 IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', 'title' => ''],
],
[
'name' => 'DBProxyEndpointId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy endpoint. You can call the DescribeDBProxy operation to query this ID.', 'type' => 'string', 'required' => false, 'example' => 'keaxncrjluwu0gue****', 'title' => ''],
],
[
'name' => 'DBProxyConnectString',
'in' => 'query',
'schema' => ['description' => 'The proxy connection string. You can call the DescribeDBProxy operation to query this connection string.', 'type' => 'string', 'required' => false, 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', 'title' => ''],
],
[
'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, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1ja4f56s7us****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved and does not need to be specified.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DBProxyConnectString' => ['description' => 'The proxy connection string.', 'type' => 'string', 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', 'title' => ''],
'DBProxyConnectStringNetType' => ['description' => 'The network type of the proxy connection string. Valid values:'."\n"
."\n"
.'- **InnerString**: Internal address.'."\n"
."\n"
.'- **OuterString**: Public address.', 'type' => 'string', 'example' => 'InnerString', 'title' => ''],
'DBProxyConnectStringPort' => ['description' => 'The port for the proxy connection string.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'DBProxyEndpointId' => ['description' => 'The ID of the proxy endpoint.', 'type' => 'string', 'example' => 'keaxncrjluwu0gue****', 'title' => ''],
'DBProxyEngineType' => ['description' => 'A reserved parameter. You can ignore this parameter.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'DBProxyFeatures' => ['description' => 'The feature settings of the proxy endpoint. The value is a string of semi-colon delimited key-value pairs. The string contains the following keys:'."\n"
."\n"
.'- **TransactionReadSqlRouteOptimizeStatus**: Specifies whether to enable transaction splitting. Valid values: **0** (disabled) and **1** (enabled).'."\n"
."\n"
.'- **ConnectionPersist**: Specifies the connection pool type. Valid values: **0** (disabled), **1** (session-level connection pool), and **2** (transaction-level connection pool).'."\n"
."\n"
.'- **ReadWriteSpliting**: Specifies whether to enable read/write splitting. Valid values: **0** (disabled) and **1** (enabled).'."\n"
."\n"
.'- **AZProximityAccess**: The nearby access feature. Valid values: **0** (disabled) and **1** (enabled).'."\n"
."\n"
.'- **CausalConsistRead**: Specifies the read consistency level. Valid values: **0** (eventual consistency), **1** (session consistency), and **2** (global consistency).'."\n"
."\n"
.'- **HtapFilter**: The automatic routing of HTAP requests. Valid values: **0** (disabled) and **1** (enabled).'."\n"
."\n"
.'- **PinPreparedStmt**: a reserved internal parameter that is visible only for ApsaraDB RDS for PostgreSQL instances.'."\n"
."\n"
.'> For ApsaraDB RDS for PostgreSQL instances, you can modify only the **ReadWriteSpliting** setting. The **TransactionReadSqlRouteOptimizeStatus** and **PinPreparedStmt** keys are permanently set to 1.', 'type' => 'string', 'example' => 'TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1', 'title' => ''],
'DBProxyNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DBProxyNodes' => [
'description' => 'The proxy nodes associated with the proxy endpoint.',
'type' => 'array',
'items' => [
'description' => 'The properties of a proxy node.',
'type' => 'object',
'properties' => [
'cpuCores' => ['description' => 'The number of CPU cores in the proxy node.', 'type' => 'string', 'example' => '2', 'title' => ''],
'nodeId' => ['description' => 'The ID of the proxy node.', 'type' => 'string', 'example' => 'pn-xxxxxxx01', 'title' => ''],
'zoneId' => ['description' => 'The ID of the availability zone where the proxy node is located.', 'type' => 'string', 'example' => 'cn-hangzhou-c', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'DbProxyEndpointAliases' => ['description' => 'The alias of the proxy endpoint.', 'type' => 'string', 'example' => 'proxyterminal-test', 'title' => ''],
'DbProxyEndpointReadWriteMode' => ['description' => 'The read/write mode of the proxy endpoint. Valid values:'."\n"
."\n"
.'- **ReadWrite**: read/write mode.'."\n"
."\n"
.'- **ReadOnly**: read-only mode.', 'type' => 'string', 'example' => 'ReadWrite', 'title' => ''],
'DbProxyEndpointVswitchId' => ['description' => 'The VSwitch ID of the proxy endpoint.', 'type' => 'string', 'example' => 'vsw-****', 'title' => ''],
'DbProxyEndpointVpcId' => ['description' => 'The VPC ID of the proxy endpoint.', 'type' => 'string', 'example' => 'vpc-****', 'title' => ''],
'DbProxyEndpointZoneId' => ['description' => 'The ID of the availability zone where the proxy endpoint is created.', 'type' => 'string', 'example' => 'cn-hangzhou-c', 'title' => ''],
'EndpointConnectItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EndpointConnectItems' => [
'description' => 'A list of details about the proxy connection strings.',
'type' => 'array',
'items' => [
'description' => 'The details of a proxy connection string.',
'type' => 'object',
'properties' => [
'DbProxyEndpointConnectString' => ['description' => 'The proxy connection string.', 'type' => 'string', 'example' => 'testproxy****.rwlb.rds.aliyuncs.com', 'title' => ''],
'DbProxyEndpointNetType' => ['description' => 'The network type. Valid values:'."\n"
."\n"
.'- **0**: Public network'."\n"
."\n"
.'- **1**: Classic network'."\n"
."\n"
.'- **2**: VPC', 'type' => 'string', 'example' => '2', 'title' => ''],
'DbProxyEndpointPort' => ['description' => 'The service port. The default value is **3306**.', 'type' => 'string', 'example' => '3306', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ReadOnlyInstanceDistributionType' => ['description' => 'The read weight distribution mode. For more information, see [Read weight allocation](~~96076~~). Valid values:'."\n"
."\n"
.'- **Standard**: The system automatically allocates read weights to instances based on their specifications.'."\n"
."\n"
.'- **Custom**: You specify custom read weights for instances.', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
'ReadOnlyInstanceMaxDelayTime' => ['description' => 'The latency threshold for read/write splitting. If the replication latency on a read-only instance exceeds this threshold, read requests are not routed to the instance. Unit: seconds.', 'type' => 'string', 'example' => '30', 'title' => ''],
'CausalConsistReadTimeout' => ['description' => 'The timeout for a consistent read, in milliseconds. Valid values: **0** to **60000**. Default: **10**.', 'type' => 'string', 'example' => '10', 'title' => ''],
'ReadOnlyInstanceWeight' => ['description' => 'The read weight distribution. The value is a JSON string that specifies the read weights of the primary and read-only instances. It contains the following fields:'."\n"
."\n"
.'- **DBInstanceId**: The instance ID.'."\n"
."\n"
.'- **DBInstanceType**: The instance type. Valid values: **Master** (primary instance) and **ReadOnly** (read-only instance).'."\n"
."\n"
.'- **NodeID**: The ID of the primary or secondary node of the primary instance if the instance runs RDS Cluster Edition.'."\n"
."\n"
.'- **NodeType**: The node type of an instance that runs RDS Cluster Edition. Valid values: **Primary** (primary node) and **Secondary** (secondary node).'."\n"
."\n"
.'- **Weight**: The read weight of the instance. The value increases in increments of **100**, with a maximum value of **10000**.', 'type' => 'string', 'example' => '[{\\"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}]]', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '847BA085-B377-4BFA-8267-F82345ECE1D2', 'title' => ''],
'DBProxyEndpointCostThresholdForDuckdb' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DBProxyEndpointMinSlaveCount' => ['description' => 'The minimum number of read-only instances to retain.', 'type' => 'string', 'example' => '2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified EndPoint is not valid.', 'description' => 'The specified proxy terminal does not exist.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', 'description' => 'This operation is not supported for the database engine of the current instance.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InvalidVpcInfo.NotFound', 'errorMessage' => 'Specified VPC info does not exist.', 'description' => 'The specified VPC does not exist.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', 'description' => 'No associated maxscale instance is found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeDBProxyEndpoint',
'summary' => 'This API retrieves the database proxy endpoint for an RDS instance.',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-02-27T15:31:18.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-11-26T16:57:00.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-10-31T06:37:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-01-22T14:14:25.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T14:40:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-05-10T17:04:03.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxyEndpoint'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBProxyEndpoint',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","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 \\"DBProxyEndpointCostThresholdForDuckdb\\": \\"\\",\\n \\"DBProxyEndpointMinSlaveCount\\": \\"2\\"\\n}","type":"json"}]',
],
'DescribeDBProxyPerformance' => [
'summary' => 'This API is used to query the performance data of the database proxy 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' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', 'title' => ''],
],
[
'name' => 'DBProxyInstanceType',
'in' => 'query',
'schema' => ['description' => 'The type of the database proxy instance. Valid values:'."\n"
."\n"
.'- common: the general-purpose database proxy'."\n"
."\n"
.'- exclusive: the dedicated database proxy', 'type' => 'string', 'required' => false, 'example' => 'exclusive', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-19T01:00:00Z', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-21T18:00:00Z', 'title' => ''],
],
[
'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' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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"
."\n"
.'- **Maxscale\\_CurrentConns**: the number of connections that are established'."\n"
."\n"
.'- **Maxscale\\_DownFlows**: outbound traffic'."\n"
."\n"
.'- **Maxscale\\_UpFlows**: inbound traffic'."\n"
."\n"
.'- **Maxscale\\_QPS**: QPS'."\n"
."\n"
.'- **Maxscale\\_MemUsage**: memory usage'."\n"
."\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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Maxscale_CpuUsage', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n3a****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'name' => 'Dimension',
'in' => 'query',
'schema' => ['description' => 'Dimension.', 'type' => 'string', 'required' => false, 'example' => 'service,node'."\n"
.'server,node'."\n"
.'service', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time of the query.', 'type' => 'string', 'example' => '2019-09-21T18:00:00Z', 'title' => ''],
'StartTime' => ['description' => 'The start time of the query.', 'type' => 'string', 'example' => '2019-09-19T01:00:00Z', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'lsme****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD31056F-A0CE-41D7-AD39-689B6ABAE982', 'title' => ''],
'DBProxyEngineType' => ['description' => 'An internal parameter. You do not need to specify this parameter.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'PerformanceKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceKey' => [
'description' => 'The performance list.',
'type' => 'array',
'items' => [
'description' => 'Performance information.',
'type' => 'object',
'properties' => [
'ValueFormat' => ['description' => 'The format in which the value of the performance metric is returned.', 'type' => 'string', 'example' => 'docker_container_cpu', 'title' => ''],
'Key' => ['description' => 'The performance parameter.', 'type' => 'string', 'example' => 'cpu_ratio', 'title' => ''],
'Values' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PerformanceValue' => [
'description' => 'The performance metrics.',
'type' => 'array',
'items' => [
'description' => 'Performance value details.',
'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.', 'type' => 'string', 'example' => '2019-10-10T09:00:00Z', 'title' => ''],
'Value' => ['description' => 'The value of the performance metric.', 'type' => 'string', 'example' => '2.83', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Service' => ['description' => 'The service dimension.', 'type' => 'string', 'example' => 'mr-xxx', 'title' => ''],
'Node' => ['description' => 'Proxy node ID', 'type' => 'string', 'example' => 'pn-xxx', 'title' => ''],
'Server' => ['description' => 'Database node ID', 'type' => 'string', 'example' => 'rn-xxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
['errorCode' => 'InvalidTargetEntity.Malformed', 'errorMessage' => 'the specified target entity is not found.', 'description' => 'The queried entity does not exist'],
],
403 => [
['errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', 'description' => 'The parameter is not found for the interface.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', 'description' => 'No associated maxscale instance is found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
408 => [
['errorCode' => 'InvalidOthers.Timeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', 'description' => 'Request timed out, please try again or narrow the time range'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query Performance Data of PolarProxy',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'> Starting from October 17, 2023, ApsaraDB RDS MySQL Cluster Edition gradually provides one free dedicated database proxy per instance in each edge zone. For more information, see [Offer: One Free Dedicated Database Proxy for RDS MySQL Cluster Edition](~~2555466~~).'."\n"
."\n"
.'### Related Function Documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before using this API, carefully read the function documentation to fully understand the prerequisites and potential impacts of using this API before performing any operation.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [View Monitoring Data for RDS MySQL](~~194241~~)'."\n"
."\n"
.'- [View Monitoring Data for RDS PostgreSQL](~~418275~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-10T14:37:51.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-11-21T13:51:05.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
['createdAt' => '2024-04-12T12:05:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-22T09:57:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-16T13:11:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T14:40:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxyPerformance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDBProxyPerformance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'IpHostPairNum' => ['description' => 'The number of distributed transaction whitelists.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'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.XX.XX,k3ecstest', 'title' => ''],
'WhitelistGroupName' => ['description' => 'The name of the distributed transaction whitelist.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2CA62A70-2203-45C6-8E90-8971D5ACC0C2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:50.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDTCSecurityIpHostsForSQLServer'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDTCSecurityIpHostsForSQLServer',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeDatabases' => [
'summary' => 'This API lists the databases in an 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. Call DescribeDBInstances to obtain this ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'testDB01', 'title' => ''],
],
[
'name' => 'DBStatus',
'in' => 'query',
'schema' => ['description' => 'The database status. Valid values:'."\n"
."\n"
.'- **Creating**: The database is being created.'."\n"
."\n"
.'- **Running**: The database is running.'."\n"
."\n"
.'- **Deleting**: The database is being deleted.', 'type' => 'string', 'required' => false, 'example' => 'Creating', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return per page. Valid values:'."\n"
."\n"
.'- **30**'."\n"
."\n"
.'- **50**'."\n"
."\n"
.'- **100**'."\n"
."\n"
.'Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'default' => '0', 'example' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. The value must be an integer greater than 0.'."\n"
."\n"
.'Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'default' => '1', 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The details of the response parameters.',
'type' => 'object',
'properties' => [
'Databases' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Database' => [
'description' => 'A list of databases.',
'type' => 'array',
'items' => [
'description' => 'Details of a database.',
'type' => 'object',
'properties' => [
'Accounts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccountPrivilegeInfo' => [
'description' => 'A list of account privileges for the database.',
'type' => 'array',
'items' => [
'description' => 'The privilege details for a specific account.',
'type' => 'object',
'properties' => [
'Account' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'AccountPrivilege' => ['description' => 'The privilege type of the account for the database. Valid values:'."\n"
."\n"
.'- **ReadWrite**: read and write permissions.'."\n"
."\n"
.'- **ReadOnly**: read-only permissions.'."\n"
."\n"
.'- **DMLOnly**: DML-only permissions.'."\n"
."\n"
.'- **DDLOnly**: DDL-only permissions.', 'type' => 'string', 'example' => 'DMLOnly', 'title' => ''],
'AccountPrivilegeDetail' => ['description' => 'The specific database privileges of the account.', 'type' => 'string', 'example' => 'SELECT', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'AdvancedInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AdvancedDbProperty' => [
'description' => 'The advanced properties of the database.'."\n"
."\n"
.'> This parameter is returned only for instances that run SQL Server.',
'type' => 'array',
'items' => ['description' => 'The details of an advanced database property.', 'type' => 'object', 'example' => '{'."\n"
.' "allowedValues": ['."\n"
.' "OFF",'."\n"
.' "ON"'."\n"
.' ],'."\n"
.' "databasePropertyName": "ansi_nulls",'."\n"
.' "allowModify": true,'."\n"
.' "excludeLock": "0",'."\n"
.' "currentValue": "OFF"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'BasicInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BasicDbProperty' => [
'description' => 'The basic properties of the database.'."\n"
."\n"
.'> This parameter is returned only for instances that run SQL Server.',
'type' => 'array',
'items' => ['description' => 'The details of a basic database property.', 'type' => 'object', 'example' => '{'."\n"
.' "allowedValues": ['."\n"
.' "CHECKSUM"'."\n"
.' ],'."\n"
.' "databasePropertyName": "page_verify",'."\n"
.' "allowModify": true,'."\n"
.' "excludeLock": "0",'."\n"
.' "currentValue": "CHECKSUM"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'CharacterSetName' => ['description' => 'The character set of the database.', 'type' => 'string', 'example' => 'utf8', 'title' => ''],
'Collate' => ['description' => 'The collation of the database. A value of C indicates the C locale.'."\n"
."\n"
.'> This parameter is returned only for instances that run PostgreSQL.', 'type' => 'string', 'example' => 'C', 'title' => ''],
'ConnLimit' => ['description' => 'The maximum number of concurrent connections. A value of -1 indicates that the number of concurrent connections is not limited.'."\n"
."\n"
.'> This parameter is returned only for instances that run PostgreSQL.', 'type' => 'string', 'example' => '-1', 'title' => ''],
'Ctype' => ['description' => 'The character set type of the database.'."\n"
."\n"
.'> This parameter is returned only for instances that run PostgreSQL.', 'type' => 'string', 'example' => 'en_US.utf8', 'title' => ''],
'DBDescription' => ['description' => 'The description of the database.', 'type' => 'string', 'example' => 'testdb', 'title' => ''],
'DBInstanceId' => ['description' => 'The ID of the instance to which the database belongs.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'testDB01', 'title' => ''],
'DBStatus' => ['description' => 'The status of the database. Valid values:'."\n"
."\n"
.'- **Creating**: The database is being created.'."\n"
."\n"
.'- **Running**: The database is running.'."\n"
."\n"
.'- **Deleting**: The database is being deleted.'."\n"
."\n"
.'- **Cold**: The database is being archived.', 'type' => 'string', 'example' => 'Creating', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RuntimeInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RuntimeDbProperty' => [
'description' => 'The runtime properties of the database.'."\n"
."\n"
.'> This parameter is returned only for instances that run SQL Server.',
'type' => 'array',
'items' => ['description' => 'The details of a runtime database property.', 'type' => 'object', 'example' => '{'."\n"
.' "allowedValues": [],'."\n"
.' "databasePropertyName": "TotalDataSizeInMB",'."\n"
.' "allowModify": false,'."\n"
.' "currentValue": "5.38"'."\n"
.'}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Tablespace' => ['description' => 'The tablespace of the database.'."\n"
."\n"
.'> This parameter is returned only for instances that run PostgreSQL.', 'type' => 'string', 'example' => 'pg_default', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.'."\n"
."\n"
.'> This parameter is returned only for instances that run SQL Server.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'DuckDBEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2603CA96-B17D-4903-BC04-61A2C829CD94', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to query account list.', 'description' => ''],
['errorCode' => 'Database.QueryError', 'errorMessage' => 'Query Db failed, please check input value and instance status.', 'description' => 'Failed to query the database. Check the specified parameters and the instance state.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is in transition. Try the statement later.', 'description' => 'The database is being modified. Try again later.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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\\": false\\n }\\n ]\\n },\\n \\"RequestId\\": \\"2603CA96-B17D-4903-BC04-61A2C829CD94\\"\\n}","type":"json"}]',
'title' => 'DescribeDatabases',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'- RDS SQL Server'."\n"
."\n"
.'- RDS MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-09T05:04:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-13T12:55:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2024-06-03T09:07:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-09T07:49:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-21T02:06:19.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2023-01-06T03:05:23.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-15T12:25:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-15T12:25:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-07-08T02:39:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-07T02:34:24.000Z', 'description' => 'Request parameters changed, Error codes changed'],
['createdAt' => '2022-03-07T02:34:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatabases'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDatabases',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupId',
'in' => 'query',
'schema' => ['description' => 'The dedicated cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9xxxxxxxx', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'BastionInstanceId' => ['description' => 'The ID of the bastion host.'."\n", 'type' => 'string', 'example' => 'bastionhost-cn-m7xxxxxxxx', 'title' => ''],
'CpuAllocateRation' => ['description' => 'The percentage of allocated cores in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '25', 'title' => ''],
'CpuAllocatedAmount' => ['description' => 'The number of allocated cores in the dedicated cluster.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''],
'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', 'title' => ''],
'CreateTime' => ['description' => 'The timestamp when the dedicated cluster was created.'."\n", 'type' => 'string', 'example' => '1571125370000', 'title' => ''],
'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', 'title' => ''],
'DedicatedHostGroupDesc' => ['description' => 'The name of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'testHostGroup', 'title' => ''],
'DedicatedHostGroupId' => ['description' => 'The ID of the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', 'title' => ''],
'DiskAllocateRation' => ['description' => 'The percentage of allocated disk space in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.49', 'title' => ''],
'DiskAllocatedAmount' => ['description' => 'The amount of allocated disk space in the dedicated cluster. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''],
'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', 'title' => ''],
'DiskUsedAmount' => ['description' => 'The amount of used disk space in the dedicated cluster. Unit: GB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''],
'DiskUtility' => ['description' => 'The disk usage of the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instances in the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'HostNumber' => ['description' => 'The total number of hosts in the dedicated cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'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', 'title' => ''],
'InstanceNumber' => ['description' => 'The total number of instances in the dedicated cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'MemAllocateRation' => ['description' => 'The percentage of allocated memory space in the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '33.7', 'title' => ''],
'MemAllocatedAmount' => ['description' => 'The amount of allocated memory space in the dedicated cluster.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '16384', 'title' => ''],
'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', 'title' => ''],
'MemUsedAmount' => ['description' => 'The amount of used memory space in the dedicated cluster. Unit: MB.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''],
'MemUtility' => ['description' => 'The memory usage of the dedicated cluster. Unit: %.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'VPCId' => ['description' => 'The ID of the virtual private cloud (VPC) to which the dedicated cluster belongs.'."\n", 'type' => 'string', 'example' => 'vpc-bp1oxxxxxx', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AB44DC0A-7E77-442A-97A9-C6418694CB22', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-06-30T06:03:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedHostGroups'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDedicatedHostGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102565235', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
[
'name' => 'DedicatedHostId',
'in' => 'query',
'schema' => ['description' => 'The ID of the host in the dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ch-t4nn100ddxxxxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DedicatedHostGroupId' => ['description' => 'The host group ID.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'BastionInstanceId' => ['description' => 'The bastion host ID.'."\n", 'type' => 'string', 'example' => 'bastionhost-cn-m7xxxxxxxx', 'title' => ''],
'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', 'title' => ''],
'CpuUsed' => ['description' => 'The number of used CPU cores on the host. Unit: cores.'."\n", 'type' => 'string', 'example' => '4', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the host was created.'."\n", 'type' => 'string', 'example' => '2021-03-25 17:29:06.0', 'title' => ''],
'DedicatedHostGroupId' => ['description' => 'The dedicated cluster ID.'."\n", 'type' => 'string', 'example' => 'dhg-7a9xxxxxxxx', 'title' => ''],
'DedicatedHostId' => ['description' => 'The host ID.'."\n", 'type' => 'string', 'example' => 'i-bpxxxxxxx', 'title' => ''],
'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', 'title' => ''],
'EndTime' => ['description' => 'The time when the host expires.'."\n", 'type' => 'string', 'example' => '2021-04-25T16:00:00Z', 'title' => ''],
'Engine' => ['description' => 'The database engine of instances that are created on the host.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'HostCPU' => ['description' => 'The total number of CPU cores that are configured for the host. Unit: cores.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''],
'HostClass' => ['description' => 'The instance type of the host.'."\n", 'type' => 'string', 'example' => 'ecs.i2.16xlarge', 'title' => ''],
'HostMem' => ['description' => 'The total memory space of the host. Unit: MB.'."\n", 'type' => 'string', 'example' => '32238', 'title' => ''],
'HostName' => ['description' => 'The host name.'."\n", 'type' => 'string', 'example' => 'testHost1', 'title' => ''],
'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', 'title' => ''],
'HostStorage' => ['description' => 'The storage capacity of the host. Unit: MB.'."\n", 'type' => 'string', 'example' => '2097152', 'title' => ''],
'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', 'title' => ''],
'IPAddress' => ['description' => 'The internal IP address of the host.'."\n", 'type' => 'string', 'example' => '192.xx.xx.xx', 'title' => ''],
'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', 'title' => ''],
'InstanceNumber' => ['description' => 'The total number of instances that are created on the host.'."\n", 'type' => 'string', 'example' => '4', 'title' => ''],
'MemAllocationRatio' => ['description' => 'The maximum memory usage per host in the dedicated cluster.'."\n", 'type' => 'string', 'example' => '90', 'title' => ''],
'MemoryUsed' => ['description' => 'The size of the used memory. Unit: MB.'."\n", 'type' => 'string', 'example' => '16384', 'title' => ''],
'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', 'title' => ''],
'StorageUsed' => ['description' => 'The amount of used storage space on the host.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'VPCId' => ['description' => 'The ID of the virtual private cloud (VPC) to which the host belongs.'."\n", 'type' => 'string', 'example' => 'vpc-bpxxxxxxx', 'title' => ''],
'VSwitchId' => ['description' => 'The ID of the vSwitch associated with the specified VPC.'."\n", 'type' => 'string', 'example' => 'vsw-bpxxxxxxx', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the host.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C860658E-68A6-46C1-AF6E-3AE7C4D3CACF', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The userid have no permission.', 'description' => 'The user does not have permissions.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDedicatedHostGroup.NotFound', 'errorMessage' => 'Specified DedicatedHostGroup does not exists.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-03T02:24:00.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedHosts'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDedicatedHosts',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'required' => false, 'example' => '327****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['description' => 'The backup method. Valid values:'."\n"
."\n"
.'* **Automated**'."\n"
.'* **Manual**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Automated', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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/****', 'title' => ''],
'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', 'title' => ''],
'BackupId' => ['description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => '32102****', 'title' => ''],
'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/****', 'title' => ''],
'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', 'title' => ''],
'BackupMode' => ['description' => 'The backup method. Valid values:'."\n"
."\n"
.'* **Automated**'."\n"
.'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''],
'BackupSize' => ['description' => 'The backup size. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2167808', 'title' => ''],
'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', 'title' => ''],
'BackupStatus' => ['description' => 'The status of the backup set. Valid values:'."\n"
."\n"
.'* **Success**'."\n"
.'* **Failed**'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
'BackupType' => ['description' => 'The backup type of the backup file. Valid values:'."\n"
."\n"
.'* **FullBackup**'."\n"
.'* **IncrementalBackup**'."\n", 'type' => 'string', 'example' => 'FullBackup', 'title' => ''],
'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', 'title' => ''],
'DBInstanceComment' => ['description' => 'The description of the instance.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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' => '588****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'StoreStatus' => ['description' => 'Indicates whether the data backup file can be deleted. Valid values:'."\n"
."\n"
.'* **Enabled**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Disabled', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A6D328C-84B8-40DC-BF49-6C73984D7494', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:50.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-01-12T15:20:50.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDetachedBackups'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeDetachedBackups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeErrorLogs' => [
'summary' => 'This API queries the error logs of an instance within a specified period.',
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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' => 'Details of an error log entry.',
'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', 'title' => ''],
'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', 'title' => ''],
'UserIp' => ['description' => 'User IP address', 'type' => 'string', 'example' => 'xx.xx.xx.xx', 'title' => ''],
'Database' => ['description' => 'Database name.', 'type' => 'string', 'example' => 'test_db', 'title' => ''],
'User' => ['description' => 'Database user', 'type' => 'string', 'example' => 'test_user', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of error logs on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '98504E07-BB0E-40FC-B152-E4882615812C', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', 'description' => 'The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters.'],
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
408 => [
['errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', 'description' => 'Request timed out, please try again or narrow the time range'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'View Error Log ',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeErrorLogs'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeErrorLogs',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'EventId' => ['description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11000053', 'title' => ''],
'EventName' => ['description' => 'The event name.'."\n", 'type' => 'string', 'example' => 'ModifySecurityIPList', 'title' => ''],
'EventPayload' => ['description' => 'The request or context parameters of the event.'."\n", 'type' => 'string', 'example' => '{\\"Domain\\": \\"rds-inc-share.aliyuncs.com\\", \\"Api\\": \\"ReleaseInstancePublicConnection\\"}', 'title' => ''],
'EventReason' => ['description' => 'The source of the event.'."\n", 'type' => 'string', 'example' => 'FROM_USER', 'title' => ''],
'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', 'title' => ''],
'EventTime' => ['description' => 'The time when the event occurred.'."\n", 'type' => 'string', 'example' => '2019-08-20T01:08:22Z', 'title' => ''],
'EventType' => ['description' => 'The event type.'."\n", 'type' => 'string', 'example' => 'NetworkManagement', 'title' => ''],
'EventUserType' => ['description' => 'The type of the user who executed the event.'."\n", 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceName' => ['description' => 'The name of the resource associated with the event. Only instance IDs are supported for this parameter.'."\n", 'type' => 'string', 'example' => 'rm-bp****', 'title' => ''],
'ResourceType' => ['description' => 'The type of the resource associated with the event. Only instances are supported for this parameter.'."\n", 'type' => 'string', 'example' => 'instance', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidParameterCombination', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region is not supported.', 'description' => 'The operation failed. The operation is not supported in the region.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in the RDS', 'description' => 'The region ID is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-10-28T02:18:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeEvents',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'Description' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'GadTest', 'title' => ''],
'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****', 'title' => ''],
'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\\"}', 'title' => ''],
'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', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version that is run by the node.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'RegionId' => ['description' => 'The ID of the region where the node resides.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'GadInstanceName' => ['description' => 'The ID of the global active database cluster.'."\n", 'type' => 'string', 'example' => 'gad-rm-bp1npi2j8****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76AF0609-4195-5DFC-BC78-3AD76FF872BB'],
],
'title' => 'Schema of Response',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","errorExample":""}]',
'title' => 'DescribeGadInstances',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-03-14T13:34:19.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-08-11T08:51:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGadInstances'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeGadInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'GadInstance', 'arn' => 'acs:rds::{#accountId}:gadinstance/*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHADiagnoseConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHADiagnoseConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-27T07:31:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHASwitchConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHASwitchConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeHistoryEvents' => [
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ArchiveStatus',
'in' => 'query',
'schema' => ['description' => 'The resource status. Valid values: **importing**, failed, checksuccess, and deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'All', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'EventLevel',
'in' => 'query',
'schema' => ['description' => 'The event level. Valid values: ***high***, **medium**, and **low**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INFO', 'title' => ''],
],
[
'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' => 'Scheduled', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
],
[
'name' => 'EventId',
'in' => 'query',
'schema' => ['description' => 'The event ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '5345398', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'DbType' => ['description' => 'The database engine.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'DetailImpact' => ['description' => 'The pagination parameter.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'DetailReason' => ['description' => 'The details of the instance operation.'."\n", 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'EventCode' => ['description' => 'The event code.'."\n", 'type' => 'string', 'example' => 'ENT000014', 'title' => ''],
'EventDetail' => ['description' => 'The event details.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
'EventId' => ['description' => 'The event ID.'."\n", 'type' => 'string', 'example' => '669036', 'title' => ''],
'EventImpact' => ['description' => 'The event impact.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
'EventLevel' => ['description' => 'The event level. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'INFO', 'title' => ''],
'EventReason' => ['description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
'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', 'title' => ''],
'EventType' => ['description' => 'The event type. Valid values:'."\n", 'type' => 'string', 'example' => 'StatusNotification', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'HandleStatus' => ['description' => 'The handling status.'."\n", 'type' => 'string', 'example' => 'done', 'title' => ''],
'HasLifeCycle' => ['description' => 'Indicates whether the event has a lifecycle.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'dhimgsearch', 'title' => ''],
'IsClosed' => ['description' => 'Indicates whether the alert is closed. Valid values: **0**: closed. **1**: not closed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Product' => ['description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''],
'RegionId' => ['description' => 'The region ID. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'example' => 'cn-guangzhou', 'title' => ''],
'ResourceType' => ['description' => 'The resource type. The value is fixed as **INSTANCE**.'."\n", 'type' => 'string', 'example' => 'Instance', 'title' => ''],
'SourceType' => ['description' => 'The type of the source data.'."\n", 'type' => 'string', 'example' => 'MSE', 'title' => ''],
'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', 'title' => ''],
'Uid' => ['description' => 'The ID of the resource owner.'."\n", 'type' => 'string', 'example' => '16986832xxxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Id' => ['description' => 'The task ID'."\n", 'type' => 'string', 'example' => '4309', 'title' => ''],
'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'Source' => ['description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'loanBill', 'title' => ''],
'Specversion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'Subject' => ['description' => 'The name of the pending event.'."\n", 'type' => 'string', 'example' => 'QiTian', 'title' => ''],
'Time' => ['description' => 'The amount of time that has elapsed from the start time of the query. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1675232573125', 'title' => ''],
'Type' => ['description' => 'The event type. For more information, see [View the event history of an ApsaraDB RDS instance](~~129759~~).'."\n", 'type' => 'string', 'example' => 'host', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number. Valid values: any non-zero positive integer. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7A41C147-C8D0-4DAE-A1A2-17EBCD60DFA1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => 'The end time cannot be earlier than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeHistoryEvents',
'summary' => 'Queries historical events in the event center.',
'changeSet' => [
['createdAt' => '2025-03-12T09:09:21.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEvents'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeHistoryEvents',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeHistoryEventsStat' => [
'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', 'title' => ''],
],
[
'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' => 'Archived', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '31', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E52666CC-330E-418A-8E5B-A19E3FB42D13', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => 'The end time cannot be earlier than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeHistoryEventsStat',
'summary' => 'Queries the statistics of historical events in the event center.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEventsStat'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeHistoryEventsStat',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Items\\": [\\n {\\n \\"EventCategory\\": \\"Exception\\",\\n \\"TotalCount\\": 31\\n }\\n ],\\n \\"RequestId\\": \\"E52666CC-330E-418A-8E5B-A19E3FB42D13\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => ['description' => 'Only Instance is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ae****', 'title' => ''],
],
],
'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\\"}]}', 'title' => ''],
'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****', 'title' => ''],
'CallerUid' => ['description' => 'The source of the request. Valid values:'."\n"
."\n"
.'* **System**'."\n"
.'* **User**'."\n", 'type' => 'string', 'example' => 'User', 'title' => ''],
'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', 'title' => ''],
'DbType' => ['description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EndTime' => ['description' => 'The end time of the task.'."\n", 'type' => 'string', 'example' => '2022-02-03T12:06:17Z', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'InstanceType' => ['description' => 'The instance category.'."\n", 'type' => 'string', 'example' => 'Instance', 'title' => ''],
'Product' => ['description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''],
'Progress' => ['description' => 'Indicates the task progress.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''],
'ReasonCode' => ['description' => 'The reason why the current task was initiated.'."\n", 'type' => 'string', 'example' => ' ****', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''],
'RemainTime' => ['description' => 'The estimated amount of time remaining to complete the task. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
'StartTime' => ['description' => 'The start time of the task.'."\n", 'type' => 'string', 'example' => '2022-02-03T11:31:03Z', 'title' => ''],
'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', 'title' => ''],
'TaskDetail' => ['description' => 'The task details.'."\n", 'type' => 'string', 'example' => '{\\"callerUid\\":\\"test\\"}', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-83br18hloy3faf****', 'title' => ''],
'TaskType' => ['description' => 'The task type.'."\n", 'type' => 'string', 'example' => 'autotest_dispatch_cases', 'title' => ''],
'Uid' => ['description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'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****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of tasks that meet these constraints without taking pagination into account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => 'The end time cannot be earlier than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-11-20T11:22:24.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHistoryTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-2ze704f*****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '12221', 'title' => ''],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => 'The task type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'TotalCount' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => 'The end time cannot be earlier than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeHistoryTasksStat',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHistoryTasksStat',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeHostGroupElasticStrategyParameters' => [
'summary' => 'Query the elasticity policy parameters of a host group ',
'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', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupName',
'in' => 'query',
'schema' => ['description' => 'The name of the dedicated cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dhg-d0dwi82293b2w9t5', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'CpuShar' => ['description' => 'The CPU utilization of the instance. Unit: percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'CpuZoom' => ['description' => 'The number of CPU cores used by the instance. Unit: cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'IopsZoom' => ['description' => 'The number of I/O requests.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'MaxConnZoom' => ['description' => 'The maximum number of concurrent connections supported by the instance type.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'MemoryZoom' => ['description' => 'The total memory size of the instance in the dedicated cluster. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', 'description' => ''],
['errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', 'description' => ''],
['errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', 'description' => ''],
['errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', 'description' => ''],
['errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', 'description' => ''],
],
403 => [
['errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', 'description' => ''],
['errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'Physical Custins Not Found!', 'description' => ''],
['errorCode' => 'HostInfo.NotFound ', 'errorMessage' => 'Current cluster not found host info!', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query the elasticity policy configuration of a host group ',
'changeSet' => [
['createdAt' => '2025-02-28T09:13:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostGroupElasticStrategyParameters'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHostGroupElasticStrategyParameters',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'AccountPassword',
'in' => 'query',
'schema' => ['description' => 'The password of the host account.'."\n", 'type' => 'string', 'required' => true, 'example' => '****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'LoginUrl' => ['description' => 'The webshell URL.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '842B73C8-5776-4BD9-9872-69C8C46DD7D3'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'WebShellLoginFailed', 'errorMessage' => '%s,%s.', 'description' => ''],
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', 'description' => ''],
['errorCode' => 'InvalidHostStatus.Format', 'errorMessage' => 'Specified host status is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ClusterTypeNotSupported', 'errorMessage' => 'The current Instance ClusterType does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostWebShell'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeHostWebShell',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LoginUrl\\": \\"****\\",\\n \\"RequestId\\": \\"842B73C8-5776-4BD9-9872-69C8C46DD7D3\\"\\n}","type":"json"}]',
],
'DescribeImportTask' => [
'summary' => 'Retrieves the details of a data import task for an RDS instance that uses native replication.',
'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' => 'The region ID. You can call the `DescribeRegions` operation to query the latest list of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the `DescribeDBInstances` operation to query the IDs of your instances.', 'type' => 'string', 'required' => true, 'example' => 'rm-****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '159****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '416980000', 'title' => ''],
'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'test01', 'title' => ''],
'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'Importing', 'title' => ''],
'Detail' => ['description' => 'The details of the task.', 'type' => 'string', 'example' => 'Error Message', 'title' => ''],
'TargetInstanceName' => ['description' => 'The name of the target instance for the data import.', 'type' => 'string', 'example' => 'rm-t4neh0q12v1******', 'title' => ''],
'TaskType' => ['description' => 'The type of the task.', 'type' => 'string', 'example' => 'import'."\n", 'title' => ''],
'SourceIp' => ['description' => 'The source IP address.', 'type' => 'string', 'example' => '59.172.25.122', 'title' => ''],
'SourcePort' => ['description' => 'The port of the source MySQL database.', 'type' => 'string', 'example' => '3306', 'title' => ''],
'Account' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'myadmin', 'title' => ''],
'DbVersion' => ['description' => 'The kernel version.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'SourceCategory' => ['description' => 'The category of the source instance.'."\n"
."\n"
.'- **ECS**: an ECS instance.'."\n"
."\n"
.'- **other**: other instance types.', 'type' => 'string', 'example' => 'aliyunRDS', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query import job details ',
'description' => 'Use this operation to retrieve the details of a specific data import task.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeImportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeImportTaskValidation' => [
'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' => 'The ID of the import task precheck. This ID is returned when you call the **ValidateImportTask** operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '41698****', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the RDS instance. You can call the DescribeDBInstances operation to query this ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-xjkljj****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '3E36DB6E-AE3B-53B6-A703-85F883FD1B2C'],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'- **true**: The request was successful.'."\n"
."\n"
.'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Status' => ['description' => 'The status of the task. This parameter is reserved for future use.', 'type' => 'string', 'example' => 'COMPLETED', 'title' => ''],
'Detail' => ['description' => 'The details of the import task precheck.', 'type' => 'string', 'example' => '{"ValidateAction": "Detail"}', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Queries the Details of a Precheck for an Import Job',
'summary' => 'Queries the details of a precheck for an import task. This operation returns each precheck item and its result.',
'description' => 'Call this operation to retrieve the details of an import task precheck.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeImportTaskValidation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E36DB6E-AE3B-53B6-A703-85F883FD1B2C\\",\\n \\"Success\\": true,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"Detail\\": \\"{\\\\\\"ValidateAction\\\\\\": \\\\\\"Detail\\\\\\"}\\"\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''],
],
],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp****', 'title' => ''],
'Duration' => ['description' => 'The renewal period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'Status' => ['description' => 'The instance status.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4182309D-CD29-49B1-B4A5-D7CB4D56C31F', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAutoRenewalAttribute'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeInstanceAutoRenewalAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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' => 'testdb', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBInstanceStatus' => ['description' => 'The status of the instance. For more information, see [Instance state table](~~26315~~).'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.6', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB7667B2-72C8-497B-9BD8-3B343CEF51AB', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceCrossBackupPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeInstanceCrossBackupPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The type of reserved keyword returned.'."\n", 'type' => 'string', 'example' => 'account', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
'Words' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'word' => [
'description' => 'The reserved keywords.'."\n",
'type' => 'array',
'items' => ['description' => 'The reserved keyword.'."\n", 'type' => 'string', 'example' => '"dbo,login,admin,administrator"', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-03-12T13:08:42.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceKeywords'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeInstanceKeywords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-bp191w771k******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aek3dbzqb******', 'title' => ''],
],
],
'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',
'title' => '',
],
'Data' => [
'description' => 'The data returned.'."\n",
'type' => 'object',
'properties' => [
'InsName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-bp191w771k******', 'title' => ''],
'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', 'title' => ''],
'Ips' => ['description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '12.0.X.X,10.2.X.X', 'title' => ''],
'TemplateId' => ['description' => 'The whitelist template ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', 'title' => ''],
'TemplateName' => ['description' => 'The whitelist template name.'."\n", 'type' => 'string', 'example' => 'template_123', 'title' => ''],
'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', 'description' => ''],
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:16:31.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceLinkedWhitelistTemplate'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeInstanceLinkedWhitelistTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm27qsxjj****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'KmsResourceRegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region to which the KMS resource belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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' => '1788966360******', 'title' => ''],
],
[
'name' => 'KmsResourceType',
'in' => 'query',
'schema' => ['description' => 'The type of the KMS resource. Only key is supported.', 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''],
],
[
'name' => 'KmsResourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS resource. Only key IDs are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a62f78**-65**-4f**-a0**-3ca4def8****', 'title' => ''],
],
],
'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****', 'title' => ''],
'Engine' => ['description' => 'The database engine. Valid values:'."\n"
."\n"
.'* **MySQL**'."\n"
.'* **SQLServer**'."\n"
.'* **PostgreSQL**'."\n", 'type' => 'string', 'example' => 'PostgreSQL', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'AssociateStatus' => ['description' => 'Indicates whether an associated RDS instance exists.'."\n"
."\n"
.'- **true**: Yes'."\n"
.'- **false**: No', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '38F6B598-A6D7-508A-8401-12BB9936****'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The userid have no permission.', 'description' => 'The user does not have permissions.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-07-04T06:37:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-03-20T08:00:12.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKmsAssociateResources'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeKmsAssociateResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-bp1f****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1f****', 'title' => ''],
'RecoveryBeginTime' => ['description' => 'The start of the time range to which the instance can be restored.'."\n", 'type' => 'string', 'example' => '2023-09-11T09:48:52Z', 'title' => ''],
'RecoveryEndTime' => ['description' => 'The end of the time range to which the instance can be restored.'."\n", 'type' => 'string', 'example' => '2023-09-18T08:03:09Z', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '291534CC-922B-55D5-8657-B29****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', 'description' => 'You must enter at least one selectable parameter.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', 'description' => 'You must pass in the required parameter.'],
['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'The user ID cannot be found.'],
['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'The operation failed. The UID in the request is left unspecified.'],
['errorCode' => 'LogBackupNotEnabled', 'errorMessage' => 'Specified instance does not enabled logbackup', 'description' => 'Log backup is not enabled for the specified instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => 'The specified user is not found. Please check again.'],
['errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', 'description' => 'The binary log file at the specified point in time is invalid.'],
['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLocalAvailableRecoveryTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeLocalAvailableRecoveryTime',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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/****', 'title' => ''],
'FileSize' => ['description' => 'The size of the log file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '788480', 'title' => ''],
'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/****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of log files on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8EC669C-FC85-43D7-AF06-C3641626B37E', 'title' => ''],
'TotalFileSize' => ['description' => 'The total size of log files. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2300', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of log files.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', 'description' => 'The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', 'description' => ''],
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary parameter is absence.', 'description' => 'You must pass in the required parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogBackupFiles'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeLogBackupFiles',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeMarketingActivity' => [
'summary' => 'Obtain information about instances pending upgrade in the RDS Marketing project ',
'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', 'title' => ''],
],
[
'name' => 'Bid',
'in' => 'query',
'schema' => ['description' => '* China site: 26842'."\n"
.'* International site: 26888'."\n", 'type' => 'string', 'required' => false, 'example' => '26842', 'title' => ''],
],
[
'name' => 'UpgradeCode',
'in' => 'query',
'schema' => ['description' => 'The service name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'series', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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', 'title' => ''],
'Bid' => ['description' => '* China site: 26842'."\n"
.'* International site: 26888'."\n", 'type' => 'string', 'example' => '26842', 'title' => ''],
'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', 'title' => ''],
'ChargeType' => ['description' => 'The payment type. Valid values:'."\n"
."\n"
.'* POSTPAY: pay-as-you-go'."\n"
.'* PREPAY: subscription'."\n", 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
'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', 'title' => ''],
'ClassGroup' => ['description' => 'The instance family. For more information, see [Overview of instance families](~~57184~~).'."\n", 'type' => 'string', 'example' => 'x', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'DiskSize' => ['description' => 'The disk capacity per node. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '900', 'title' => ''],
'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', 'title' => ''],
'EngineVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
'MaxConnections' => ['description' => 'The maximum number of concurrent connections.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'MaxIombps' => ['description' => 'The maximum I/O throughput. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'MaxIops' => ['description' => 'The maximum IOPS.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'Memory' => ['description' => 'The memory size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''],
'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', 'title' => ''],
'UpgradeCategory' => ['description' => 'The RDS edition after the upgrade.'."\n", 'type' => 'string', 'example' => 'HighAvailability', 'title' => ''],
'UpgradeClassCode' => ['description' => 'The instance type after the upgrade.'."\n", 'type' => 'string', 'example' => 'rds.mysql.s3.large', 'title' => ''],
'UpgradeClassGroup' => ['description' => 'The instance family after the upgrade.'."\n", 'type' => 'string', 'example' => 'd', 'title' => ''],
'UpgradeCpu' => ['description' => 'The number of CPU cores after the upgrade.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''],
'UpgradeDescContent' => ['description' => 'The description of the upgrade.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'UpgradeDiskSize' => ['description' => 'The disk capacity after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''],
'UpgradeMaxConnections' => ['description' => 'The maximum number of concurrent connections after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
'UpgradeMaxIombps' => ['description' => 'The maximum I/O throughput after the upgrade. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'UpgradeMaxIops' => ['description' => 'The maximum IOPS after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
'UpgradeMemory' => ['description' => 'The memory size after the upgrade.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''],
'UpgradeReferencePrice' => ['description' => 'The reference price of the upgrade.'."\n", 'type' => 'string', 'example' => '23333.1', 'title' => ''],
'UpgradeStorageType' => ['description' => 'The storage type after the upgrade.'."\n", 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '7D8F09DB-1124-5D78-A520-FF88FAF4351B'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query Marketing Campaigns',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMarketingActivity'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeMarketingActivity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeMaskingRules' => [
'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' => 'The instance name.', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******5', 'title' => ''],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The rule names, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'test1,test2', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Rules' => [
'description' => 'A list of encryption or masking rules.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DefaultAlgo' => ['description' => 'The default encryption or masking algorithm.', 'type' => 'string', 'example' => 'aes-128-gcm', 'title' => ''],
'Enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'MaskingAlgo' => ['description' => 'The masking algorithm or algorithms. You can add parameters to an algorithm in the following format: {name: algorithm1}, {name: algorithm2, params: {position, length}}', 'type' => 'string', 'example' => '[{"name": "aes-128-gcm"},'."\n"
.' {"name":"sm4-128-gcm"}]', 'title' => ''],
'RuleConfig' => [
'description' => 'The rule configuration.',
'type' => 'object',
'properties' => [
'Columns' => [
'description' => 'The columns to which the rule applies.',
'type' => 'array',
'items' => ['description' => 'An asterisk (\\*) indicates all columns.', 'type' => 'string', 'example' => '*', 'title' => ''],
'title' => '',
'example' => '',
],
'Databases' => [
'description' => 'The databases to which the rule applies.',
'type' => 'array',
'items' => ['description' => 'An asterisk (\\*) indicates all databases.', 'type' => 'string', 'example' => '*', 'title' => ''],
'title' => '',
'example' => '',
],
'Tables' => [
'description' => 'The tables to which the rule applies.',
'type' => 'array',
'items' => ['description' => 'An asterisk (\\*) indicates all tables.', 'type' => 'string', 'example' => '*', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '69779000-57A4-38F6-BF85-**********A2'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query encryption or desensitization rules ',
'summary' => 'Lists encryption or data masking rules for a specified instance.',
'description' => '## Usage notes'."\n"
."\n"
.'- Before calling this API, ensure column encryption is enabled in the DAS Security Center.'."\n"
."\n"
.'- If you receive the `ColumnEncryptionErrorCode.NOT_PURCHASED` error, purchase and enable column encryption in the DAS (Database Autonomy Service) Security Center, then try again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeMaskingRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'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"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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' => '14***', 'title' => ''],
],
[
'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 ', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'Size' => ['description' => 'The table size. Unit: KB.'."\n", 'type' => 'string', 'example' => '64', 'title' => ''],
'Tables' => ['description' => 'The table name.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '60F9A12A-16B8-4728-B099-4CA38D32C31C', 'title' => ''],
'TotalPageCount' => ['description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset', 'description' => ''],
['errorCode' => 'InvalidPageSize', 'errorMessage' => 'The page size is invalid', 'description' => 'The value of the pageSize parameter is invalid. The value of this parameter must be a number.'],
['errorCode' => 'InvalidPageIndex', 'errorMessage' => 'The page index is invalid', 'description' => ''],
['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidMeta.Empty', 'errorMessage' => 'Meta information is empty.', 'description' => 'The meta information is empty. Check whether a full backup has not been performed after the database table is restored.'],
['errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', 'description' => 'The metadata information is too large. Check whether the number of instance tables exceeds 50000.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter({}) is not valid.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-04-28T11:18:06.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-04T09:19:51.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetaList'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeMetaList',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-bp11e1tzg****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'mytestdb', 'title' => ''],
'Description' => ['description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => 'Success to DBCC checkdb asynchronously', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'MigrateTaskId' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '235943', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6ED3635A-01F9-47BD-B9C8-CB3FD70A336E', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The operation failed. The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.'],
['errorCode' => 'InvalidMigrateTask', 'errorMessage' => 'The specified MigrateTaskId 237360 does not exist. Please check again.', 'description' => 'The backup data migration task with the 237360 ID cannot be found.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', 'description' => 'The operation failed. The RDS instance is unavailable.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-08-15T08:50:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-04T09:19:51.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMigrateTaskById'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeMigrateTaskById',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testDB', 'title' => ''],
'Description' => ['description' => 'The description of the migration task.'."\n", 'type' => 'string', 'example' => 'Api description', 'title' => ''],
'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', 'title' => ''],
'IsDBReplaced' => ['description' => 'Indicates whether the imported data overwrites the existing data.'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''],
'MigrateTaskId' => ['description' => 'The migration task ID.'."\n", 'type' => 'string', 'example' => '564522545', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4E356DDF-6B83-45DB-99D5-4B1E8A0D286B', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time', 'description' => 'The end time must be later than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidInstanceState', 'errorMessage' => 'The DB instance state does not support this operation.', 'description' => 'The operation failed. The RDS instance is unavailable.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-08-04T09:19:51.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMigrateTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeMigrateTasks',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1lymyn1v3i****', 'title' => ''],
'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', 'title' => ''],
'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
'Mask' => ['description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'Method' => ['description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'ldap', 'title' => ''],
'Option' => ['description' => 'The value of this parameter was set based on the value of the Method parameter.'."\n", 'type' => 'string', 'example' => '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", 'title' => ''],
'PriorityId' => ['description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Type' => ['description' => 'The connection type.'."\n", 'type' => 'string', 'example' => 'host', 'title' => ''],
'User' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'ldapuser', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
'Mask' => ['description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'Method' => ['description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'md5', 'title' => ''],
'Option' => ['description' => 'The value of this parameter varies based on the value of the Method parameter.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'PriorityId' => ['description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Type' => ['description' => 'The connection type.'."\n", 'type' => 'string', 'example' => 'host', 'title' => ''],
'User' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'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', 'title' => ''],
'StatusReason' => ['description' => 'The reason why the modification failed.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'LogItemCount' => ['description' => 'The number of modification records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6D797E6B-E157-510C-A27F-6F9E6DA40633', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStartTime.Format', 'errorMessage' => 'Specified start time is not valid.', 'description' => 'The start time is invalid.'],
['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The end time is invalid. Check the end time.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","errorExample":""}]',
'title' => 'DescribeModifyPGHbaConfigLog',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'RDS PostgreSQL'."\n",
'changeSet' => [
['createdAt' => '2022-08-04T09:19:52.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-02-14T06:22:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-11-23T12:09:14.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyPGHbaConfigLog'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeModifyPGHbaConfigLog',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '5.6', 'title' => ''],
'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', 'title' => ''],
'NewParameterValue' => ['description' => 'The new value of the parameter.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''],
'OldParameterValue' => ['description' => 'The original value of the parameter.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''],
'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'innodb_stats_sample_pages', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C8E88DED-533F-4B3C-9207-731FBF394CCA', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-27T07:31:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyParameterLog'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeModifyParameterLog',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Description' => ['description' => 'The description of the backup file.'."\n", 'type' => 'string', 'example' => 'App description', 'title' => ''],
'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', 'title' => ''],
'FileName' => ['description' => 'The name of the backup file stored in the Object Storage Service (OSS) bucket.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'FileSize' => ['description' => 'The size of the backup file. Unit: MB'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'IsAvailable' => ['description' => 'Indicates whether the backup file is available. Valid values: **True and False**.'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'MigrateTaskId' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'example' => '562154852', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5409D02-D661-4BF3-8F3D-0A814D0574E7', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-08-15T07:38:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-04T09:19:52.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOssDownloads'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeOssDownloads',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Mask' => ['description' => 'The mask of the instance. The value is fixed as null.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'Method' => ['description' => 'The authentication method. The value is fixed as md5.'."\n", 'type' => 'string', 'example' => 'md5', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Type' => ['description' => 'The type of connection to the instance. The value is fixed as host.'."\n", 'type' => 'string', 'example' => 'host', 'title' => ''],
'User' => ['description' => 'The user that is allowed to access the instance. The value is fixed as all.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'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', 'title' => ''],
'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.', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A147A124-A147-5CCF-9609-B73C028848DF', 'title' => ''],
'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', 'title' => ''],
'Database' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
'Mask' => ['description' => 'The mask of the IP address.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'Method' => ['description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'md5', 'title' => ''],
'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', 'title' => ''],
'PriorityId' => ['description' => 'The priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'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', 'title' => ''],
'User' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'all', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-08-04T09:19:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-02-14T06:22:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-11-23T12:09:14.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePGHbaConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribePGHbaConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeParameterGroup' => [
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '5.6', 'title' => ''],
'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', 'title' => ''],
'ParamCounts' => ['description' => 'The number of parameters in the parameter template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'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', 'title' => ''],
'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '2000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ParameterGroupDesc' => ['description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'testGroup1', 'title' => ''],
'ParameterGroupId' => ['description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'example' => 'rpg-dp****', 'title' => ''],
'ParameterGroupName' => ['description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'test123456', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp170****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '498AE8CA-8C81-4A01-AF37-2B902014ED30', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'The specified paramGroups does not exist.', 'description' => 'The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'ParamGroupOptionValue.NotFound', 'errorMessage' => 'Specified system parameter group option value not found.', 'description' => 'The specified system parameter template was not found.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeParameterGroup',
'summary' => 'Queries the information about a parameter template.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-12-27T07:23:13.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-14T08:25:36.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeParameterGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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":""}]',
],
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.7', 'title' => ''],
'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', 'title' => ''],
'ParamCounts' => ['description' => 'The number of parameters in the parameter template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'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', 'title' => ''],
'ParameterGroupId' => ['description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'example' => 'rpg-****', 'title' => ''],
'ParameterGroupName' => ['description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'test1234', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D4A23265-C5B6-42E1-98A0-EFA1EB42E723', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUID.Duplicate', 'errorMessage' => 'Specified uid is not valid.', 'description' => 'Specified uid is not valid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-05-23T09:42:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-23T13:24:25.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-07-27T13:45:30.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeParameterGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rm-bp1imnm****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'ParameterCount' => ['description' => 'The number of parameters.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'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]', 'title' => ''],
'ForceModify' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'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', 'title' => ''],
'ParameterDescription' => ['description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'Page numbers of multi blocks reading once in some ddl query.', 'title' => ''],
'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'loose_multi_blocks_ddl_count', 'title' => ''],
'ParameterValue' => ['description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0F9B7410-EC73-510C-B385-8339455C12C6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'Invalid parameter group category', 'description' => 'The operation failed. The categories of parameter groups are invalid'],
['errorCode' => 'ParameterIllegal', 'errorMessage' => 'Param is illegal parameter.', 'description' => 'The request parameter is invalid. Check the parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-11-17T08:58:25.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeParameterTemplates',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DescribeParameterTimedScheduleTask' => [
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze2za3is7baay****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A807C95D-410C-5BB5-96C0-C6E09F2C3D36', 'title' => ''],
'TaskList' => [
'description' => 'The task list.',
'type' => 'array',
'items' => [
'description' => 'The details of a task.',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The ID of the scheduled task.', 'type' => 'string', 'example' => '27056921', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'rm-2ze2za3is7baay****', 'title' => ''],
'Status' => ['description' => 'The status of the task. Valid values:'."\n"
."\n"
.'- **PENDING**: The task is pending.'."\n"
."\n"
.'- **EXECUTING**: The task is running.'."\n"
."\n"
.'- **COMPLETED**: The task has completed.'."\n"
."\n"
.'- **FAILED**: The task has failed.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
'SwitchTime' => ['description' => 'The time when the parameter modification takes effect.', 'type' => 'string', 'example' => '2022-05-06T09:24:00Z', 'title' => ''],
'Parameters' => ['description' => 'The new parameter settings, in JSON format.', 'type' => 'string', 'example' => '{"auto_increment_increment":"1000","back_log":"99"}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query Scheduled Task for Modifying Instance Parameters',
'summary' => 'Queries the details of a scheduled task that modifies instance parameters.',
'description' => '### Applicable engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'### Related feature documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before you call this API, read the relevant feature documentation to understand its prerequisites and potential impact.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Setting instance parameters for RDS MySQL](~~96063~~)'."\n"
."\n"
.'- [Setting instance parameters for RDS PostgreSQL](~~96751~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeParameterTimedScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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' => 'The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.', 'title' => ''],
'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'transaction_alloc_block_size', 'title' => ''],
'ParameterValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '8192', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Engine' => ['description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'EngineVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''],
'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', 'title' => ''],
'ParameterGroupDesc' => ['description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async', 'title' => ''],
'ParameterGroupName' => ['description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'mysql_innodb_8.0_basic_normal_high', 'title' => ''],
'ParameterGroupType' => ['description' => 'The type of the parameter template.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'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', 'title' => ''],
'ParameterDescription' => ['description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.', 'title' => ''],
'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'transaction_alloc_block_size', 'title' => ''],
'ParameterValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''],
'ParameterValueRange' => ['description' => 'The valid values of the parameter.'."\n", 'type' => 'string', 'example' => '1~100', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ConcurrentLimit', 'errorMessage' => 'The request processing has been concurrent limit.', 'description' => 'Request processing has reached the concurrency limit.'],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","errorExample":""}]',
'title' => 'DescribeParameters',
'description' => '### Applicable engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n"
.'* MariaDB'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-02-14T08:05:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-23T06:44:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-27T13:29:36.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-05-23T06:10:55.000Z', 'description' => 'Response parameters changed, Response parameters changed'],
['createdAt' => '2023-03-01T10:03:59.000Z', 'description' => 'Error codes changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeParameters',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'Comment' => ['description' => 'The purpose of the extension.'."\n", 'type' => 'string', 'example' => 'PostgreSQL load profile repository and report builder', 'title' => ''],
'DefaultVersion' => ['description' => 'The default version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', 'title' => ''],
'InstalledVersion' => ['description' => 'The current version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', 'title' => ''],
'Name' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'pg_profile', 'title' => ''],
'Owner' => ['description' => 'The user of the extension.'."\n", 'type' => 'string', 'example' => 'test_user', 'title' => ''],
'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', 'title' => ''],
'Requires' => ['description' => 'The extensions on which the current extension depends when it is installed.'."\n", 'type' => 'string', 'example' => '{dblink,plpgsql}', 'title' => ''],
'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****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Overview' => ['description' => 'The overview of the extension.'."\n", 'type' => 'object', 'example' => 'None', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC', 'title' => ''],
'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', 'title' => ''],
'Comment' => ['description' => 'The purpose of the extension.'."\n", 'type' => 'string', 'example' => 'PostgreSQL load profile repository and report builder', 'title' => ''],
'DefaultVersion' => ['description' => 'The default version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', 'title' => ''],
'InstalledVersion' => ['description' => 'The current version of the extension.'."\n", 'type' => 'string', 'example' => '4.1', 'title' => ''],
'Name' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'pg_cron', 'title' => ''],
'Owner' => ['description' => 'The user of the extension.'."\n", 'type' => 'string', 'example' => 'test_user', 'title' => ''],
'Priority' => ['description' => 'The priority of the extension.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'Requires' => ['description' => 'The extensions on which the current extension depends when it is installed.'."\n", 'type' => 'string', 'example' => '{dblink,plpgsql}', 'title' => ''],
'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****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'Database.QueryError', 'errorMessage' => 'Query Db failed, please check input value and instance status.', 'description' => 'Failed to query the database. Check the specified parameters and the instance state.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-09-03T10:37:31.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePostgresExtensions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribePostgresExtensions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => '8.0', 'title' => ''],
],
[
'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' => 'mysql.x2.medium.xc', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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.x2.medium.xc', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
'MinCapacity' => ['description' => 'The minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'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", 'title' => ''],
'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', 'title' => ''],
'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => ' 123456', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'Description' => ['description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'IsSelected' => ['description' => 'Indicates whether the coupon is selected.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'Name' => ['description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Currency' => ['description' => 'The currency unit.'."\n", 'type' => 'string', 'example' => 'CNY', 'title' => ''],
'DiscountPrice' => ['description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''],
'OrderLines' => ['description' => 'The order information.'."\n", 'type' => 'any', 'example' => 'Order Information', 'title' => ''],
'OriginalPrice' => ['description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '10508', 'title' => ''],
'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' => '100119****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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**', 'title' => ''],
'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**', 'title' => ''],
'TradePrice' => ['description' => 'The transaction price, which is equal to the original price minus the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '10508', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CA0ADDDC-0BEB-4381-A3ED-73B4C79B8CC6', 'title' => ''],
'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', 'title' => ''],
'Name' => ['description' => 'The name of the promotion rule.'."\n", 'type' => 'string', 'example' => 'Rule1', 'title' => ''],
'RuleId' => ['description' => 'The ID of the promotion rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '102002100393****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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**.*', 'title' => ''],
'RCUDiscountMinAmount' => ['description' => 'The discount amount of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1*.*', 'title' => ''],
'RCUOriginalMaxAmount' => ['description' => 'The price of the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**.*', 'title' => ''],
'RCUOriginalMinAmount' => ['description' => 'The price of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '3*.*', 'title' => ''],
'StorageOriginalAmount' => ['description' => 'The original price of the disk capacity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1*', 'title' => ''],
'TotalOriginalMaxAmount' => ['description' => 'The maximum total price before the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**.*', 'title' => ''],
'TotalOriginalMinAmount' => ['description' => 'The minimum total price before the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2*.*', 'title' => ''],
'TradeMaxRCUAmount' => ['description' => 'The transaction price of the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**.*', 'title' => ''],
'TradeMinRCUAmount' => ['description' => 'The transaction price of the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2*.*', 'title' => ''],
'storageDiscountAmount' => ['description' => 'The discounted price of the disk capacity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2.*', 'title' => ''],
],
'title' => '',
'example' => '',
],
'ShowDiscount' => ['description' => 'Indicates whether discounts can be used.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TradeMaxRCUAmount' => ['description' => 'The estimated hourly fee that is calculated based on the maximum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2**', 'title' => ''],
'TradeMinRCUAmount' => ['description' => 'The estimated hourly fee that is calculated based on the minimum number of RCUs.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1**', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DBInstanceStorageFormatFault', 'errorMessage' => 'DBInstanceStorageFormatFault', 'description' => ''],
['errorCode' => 'InvalidDBInstanceStorage.Format', 'errorMessage' => 'InvalidDBInstanceStorage.Format', 'description' => 'The storage capacity is invalid. Check the storage capacity.'],
['errorCode' => 'DBNodeParameter.InvalidClassCode', 'errorMessage' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', 'description' => 'The ClassCode configuration is invalid for the DBNode parameter.'],
['errorCode' => 'Price.WanHuaTong.sys', 'errorMessage' => 'Inquiry error.', 'description' => ''],
['errorCode' => 'SYSTEM.SaleValidateFailed', 'errorMessage' => 'The request not refer to the correct order period. please check your Period or UsedTime param.', 'description' => ''],
['errorCode' => 'Price.HsfTimeoutError', 'errorMessage' => 'Inquiry error.', 'description' => ''],
['errorCode' => 'Rule.HsfTimeoutError', 'errorMessage' => 'Request rule service error.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceClassNotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => 'The specified instance does not exist or does not support'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'DBNodeParameter.Required', 'errorMessage' => 'The DBNode parameter is required for RDS for MySQL Cluster Edition instances.', 'description' => 'For an RDS MySQL cluster instance, the DBNode parameter is required.'],
['errorCode' => 'DBNodeParameter.TooFewItems', 'errorMessage' => 'You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', 'description' => 'For an RDS MySQL cluster instance, you must configure at least two nodes for the DBNode parameter.'],
['errorCode' => 'DBNodeParameter.TooManyItems', 'errorMessage' => 'You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', 'description' => 'For an RDS MySQL cluster instance, the maximum number of nodes in the DBNode parameter is 9.'],
],
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.', 'description' => 'The account does not specify a payment method.'],
['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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the region in India. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase, renewal, and configuration change orders. Thank you for your understanding and support.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidTimeType.NotFound', 'errorMessage' => 'The parameter timeType does not exist.', 'description' => 'Check the TimeType parameter. Valid values: Year, Month, and Day.'],
['errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-04-07T02:40:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-09T05:04:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-23T13:00:15.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-05-24T06:10:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-11T13:57:25.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-11-17T08:58:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-03T08:40:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2023-05-24T10:01:00.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-05-12T09:58:25.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePrice'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribePrice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeQuickSaleConfig' => [
'summary' => 'Query RDS quick sale configuration ',
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'Items' => ['description' => 'The configuration details of the product.'."\n", 'type' => 'object', 'title' => '', 'example' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5DFFE9EC-3369-5937-A4E2-507C0C86A4C6'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query quick sale Product configuration ',
'changeSet' => [
['createdAt' => '2023-11-03T03:10:39.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeQuickSaleConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'DescribeRCClusterConfig' => [
'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, 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeRCClusterConfig',
'summary' => 'Queries the kubeconfig file of a Container Service for Kubernetes (ACK) cluster in which an RDS Custom instance resides.',
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCClusterConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCClusterConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9DD55F4-1A5F-48CA-BA57-DFB3CA8C4C34\\",\\n \\"Config\\": \\"apiVersion: v1****\\",\\n \\"Expiration\\": \\"2024-03-10T09:56:17Z\\"\\n}","type":"json"}]',
],
'DescribeRCDisks' => [
'summary' => 'Invoke the DescribeRCDisks API to view disk information of RDS Custom instances.',
'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****', 'title' => ''],
],
[
'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****"]', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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', 'title' => ''],
'Value' => ['description' => 'The value of the tag. The tag value **can be** an empty string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'type' => 'string',
'example' => 'All',
'default' => 'All',
'enum' => ['Available', 'All', 'In_use', 'Attaching', 'Detaching', 'Creating', 'ReIniting'],
'title' => '',
'description' => '',
'required' => false,
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'type' => 'string',
'example' => 'data',
'default' => 'all',
'enum' => ['all', 'system', 'data'],
'title' => '',
'description' => '',
'required' => false,
],
],
],
'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_auto', 'title' => ''],
'CreationTime' => ['description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2024-10-22T02:41:37Z', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Description' => ['description' => 'The disk description.'."\n", 'type' => 'string', 'example' => 'zd_test', 'title' => ''],
'Device' => ['description' => 'The mount point of the disk.'."\n", 'type' => 'string', 'example' => '/dev/xvda', 'title' => ''],
'DiskChargeType' => ['description' => 'The billing method of the disk.'."\n"
."\n"
.'Only **PostPaid** (pay-as-you-go) is supported.'."\n", 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
'DiskId' => ['description' => 'The disk ID.'."\n", 'type' => 'string', 'example' => 'rcd-wz9f3peueu5npsl****', 'title' => ''],
'DiskName' => ['description' => 'The disk name.'."\n", 'type' => 'string', 'example' => 'fvt-ecs-bcfb3627', 'title' => ''],
'Encrypted' => ['description' => 'Indicates whether only encrypted cloud disks are queried. Valid values:'."\n"
."\n"
.'* true'."\n"
.'* false (default)'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ExpiredTime' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'example' => 'none', 'title' => ''],
'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', 'title' => ''],
'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****', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rc-e8w1cn7634kiam****', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group to which the disk belongs.'."\n", 'type' => 'string', 'example' => 'rg-aekzescnje5khnq', 'title' => ''],
'SerialNumber' => ['description' => 'The serial number of the disk.'."\n", 'type' => 'string', 'example' => 'bp18um4r4f2fve2****', 'title' => ''],
'Size' => ['description' => 'The size of the disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'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****', 'title' => ''],
'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', 'title' => ''],
'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****', 'title' => ''],
'StorageSetId' => ['description' => 'The storage set ID.'."\n", 'type' => 'string', 'example' => 'ss-i-bp1j4i2jdf3owlhe****', 'title' => ''],
'Type' => ['description' => 'The disk type. Valid values:'."\n"
."\n"
.'* system: system disk'."\n"
.'* data: data disk'."\n", 'type' => 'string', 'example' => 'data', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
'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', 'title' => ''],
'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'testvalue1'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'AttachedTime' => ['description' => 'The mount time.', 'title' => 'Mount time.', 'type' => 'string', 'example' => '2017-12-05T2340:00Z'],
'BurstingEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'Portable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidParameter.InstanceIds', 'errorMessage' => 'The specified parameter InstanceIds is invalid.', 'description' => 'InstanceIds is invalid.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
['errorCode' => 'SDK.InvalidRegionId', 'errorMessage' => 'Can not find endpoint to access.', 'description' => 'Cannot find endpoint to access.'],
['errorCode' => 'InvalidParameter.DiskIds', 'errorMessage' => 'The specified parameter DiskIds is invalid.', 'description' => 'The specified disk parameter is invalid'],
['errorCode' => 'InvalidParameter.InstanceId', 'errorMessage' => 'The specified parameter InstanceId is invalid.', 'description' => 'The specified parameter instance ID is invalid.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query disk information of RDS Custom instances ',
'changeSet' => [
['createdAt' => '2025-05-19T02:30:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2025-05-07T03:00:42.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-31T12:29:02.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCDisks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCDisks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'CustomDisk', 'arn' => 'acs:rds:{#regionId}:{#accountId}:customdisk/{#DiskId}'],
],
],
],
],
'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\\": false,\\n \\"Portable\\": false\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"TotalCount\\": 12\\n}","type":"json"}]',
'translator' => 'machine',
],
'DescribeRCImageList' => [
'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', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'maximum' => '50', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The image type. Set the value to **self**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'self', 'default' => 'self', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => 'Image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-2oqiu973jwcxe****', 'title' => ''],
],
[
'name' => 'ImageName',
'in' => 'query',
'schema' => ['description' => 'Image Name.', 'type' => 'string', 'required' => false, 'example' => 'test_image_name', 'title' => ''],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => ['description' => 'Query images that can be used for the specified instance type.', 'type' => 'string', 'required' => false, 'example' => 'mysql.x2.xlarge.6cm', 'title' => ''],
],
],
'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', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'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', 'title' => ''],
'CreationTime' => ['description' => 'The time when the image was created.'."\n", 'type' => 'string', 'example' => '2024-04-25T02:17:40Z', 'title' => ''],
'Description' => ['description' => 'The description of the image.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'ImageId' => ['description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'm-2oqiu973jwcxe****', 'title' => ''],
'ImageName' => ['description' => 'The image name.'."\n", 'type' => 'string', 'example' => 'Created_from_i-2zeh17y17sz677x****', 'title' => ''],
'ImageVersion' => ['description' => 'The image version.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'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', 'title' => ''],
'OSName' => ['description' => 'The display name of the operating system in Chinese.'."\n", 'type' => 'string', 'example' => 'Alibaba Cloud Linux 2.1903 LTS 64位 快速启动版', 'title' => ''],
'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', 'title' => ''],
'OSType' => ['description' => 'The type of the operating system. Valid values:'."\n"
."\n"
.'* **windows**'."\n"
.'* **linux**'."\n", 'type' => 'string', 'example' => 'linux', 'title' => ''],
'Size' => ['description' => 'The image size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
'Status' => ['description' => 'The image status. Valid values:'."\n"
."\n"
.'* **Unavailable**'."\n"
.'* **Available**'."\n"
.'* **Creating**'."\n"
.'* **CreateFailed**'."\n", 'type' => 'string', 'example' => 'Available', 'title' => ''],
'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', 'title' => ''],
'IsSupportRdsCustom' => ['description' => 'Indicates whether RDS Custom instances are supported. Valid values:'."\n"
."\n"
.'- **true**: Yes.'."\n"
.'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Platform' => ['description' => 'Operating system platform. ', 'type' => 'string', 'example' => 'Aliyun', 'title' => ''],
'DiskDeviceMappings' => [
'description' => 'The mapping between disks and snapshots in the image.',
'type' => 'array',
'items' => [
'description' => 'The mapping between disks and snapshots in the image.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The property of the disk.'."\n"
."\n"
.'- **system**: system disk.'."\n"
.'- **data**: data disk.', 'type' => 'string', 'example' => 'system', 'title' => ''],
'Device' => ['description' => 'The device information of the disk, such as `/dev/xvdb`.', 'type' => 'string', 'example' => '/dev/xvdb', 'title' => ''],
'Size' => ['description' => 'The size of the disk. Unit: GiB.', 'type' => 'string', 'example' => '40', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query the list of custom images that can be used to create an RDS Custom instance',
'summary' => 'Invoke the DescribeRCImageList API and specify parameters such as RegionId to query the list of custom images that can be used to create RDS Custom instances. ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:DescribeRCImageList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeRCInstanceAttribute' => [
'summary' => 'Invoke the DescribeRCInstanceAttribute API to query the details of a single 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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'PrivateIpAddress',
'in' => 'query',
'schema' => ['description' => 'The VPC network IP address of the instance, that is, the private IP address. ', 'type' => 'string', 'required' => false, 'example' => '192.168.XXX.XXX', 'title' => ''],
],
[
'name' => 'MaxDisksResults',
'in' => 'query',
'schema' => ['description' => 'Set the upper limit for the number of instance disks in the return result. The valid range is 10 to 500. '."\n"
.'- If no value is set, the default value is 20. '."\n"
.'- If the set value is less than 10, it is fixed to 10. '."\n"
.'- If the set value is greater than or equal to 10 and less than or equal to 500, the set value is used. ', 'title' => 'Number of disks mounted to the instance to view. If no value is set, the default value is 20. If the set value is less than 10, the default value is 10. ', 'type' => 'integer', 'format' => 'int64', 'default' => '20', 'required' => false, 'example' => '20'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance name', 'title' => 'Instance Name ', 'type' => 'string', 'example' => 'k8s-node', 'required' => false],
],
],
'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', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'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', 'title' => ''],
'CreditSpecification' => ['description' => 'The performance mode of the burstable instance.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'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', 'title' => ''],
'Encrypted' => ['description' => 'Indicates whether the data disk is encrypted. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'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', 'title' => ''],
'Size' => ['description' => 'The size of the data disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
'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', 'title' => ''],
'Device' => ['description' => 'The device name of the instance to which the disk is mounted.', 'title' => 'The device name of the instance to which the disk is mounted.', 'type' => 'string', 'example' => '/dev/xvdb'],
'SnapshotId' => ['description' => 'The ID of the snapshot used to create the disk. '."\n"
.'If no snapshot was specified when creating the disk, the value of this parameter is empty.', 'title' => 'The ID of the snapshot used to create the disk. '."\n"
.'If no snapshot was specified when creating the disk, the value of this parameter is empty.', 'type' => 'string', 'example' => 'rcds-bp18um4r4f2fve24**'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'DedicatedHostName' => ['description' => 'The name of the dedicated host.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Tags' => [
'itemNode' => true,
'description' => '',
'type' => 'object',
'properties' => [
'Tag' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'Tag information.',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'rc-e8sh6w29j5l4jgjp****', 'title' => ''],
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testRC', 'title' => ''],
'ResourceType' => ['description' => 'The resource type.'."\n"
."\n"
.'- **ALIYUN::RDS::INSTANCE**: ApsaraDB RDS instance'."\n"
.'- **ALIYUN::RDS::CUSTOM**: RDS Custom instance', 'type' => 'string', 'example' => 'ALIYUN::RDS::CUSTOM', 'title' => ''],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test01', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'DeploymentSetId' => ['description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'example' => 'ds-uf6c8qerk019bj1l****', 'title' => ''],
'Description' => ['description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'DiskType' => ['description' => 'The reserved parameter.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'EcsInstanceType' => ['description' => 'The Elastic Compute Service (ECS) instance family.'."\n", 'type' => 'string', 'example' => 'ecs.g6.2xlarge', 'title' => ''],
'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****', 'title' => ''],
'Bandwidth' => ['description' => 'The maximum Internet bandwidth of the EIP. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'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', 'title' => ''],
'IpAddress' => ['description' => 'The EIP.'."\n", 'type' => 'string', 'example' => '8.147.XXX.XXX', 'title' => ''],
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'HostName' => ['description' => 'The instance hostname.'."\n", 'type' => 'string', 'example' => 'iZ2zej1n3cin51rlmby****', 'title' => ''],
'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', 'title' => ''],
'ImageId' => ['description' => 'The image ID of the instance.'."\n", 'type' => 'string', 'example' => 'm-2oqiu973jwcxe****', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rc-dh2jf9n6j4s14926****', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'InstanceNetworkType' => ['description' => 'The network type. Valid values:'."\n"
."\n"
.'* **classic**'."\n"
.'* **vpc**'."\n", 'type' => 'string', 'example' => 'vpc', 'title' => ''],
'InstanceType' => ['description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'example' => 'mysql.x4.xlarge.6cm', 'title' => ''],
'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', 'title' => ''],
'InternetMaxBandwidthIn' => ['description' => 'The maximum inbound bandwidth from the Internet. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'InternetMaxBandwidthOut' => ['description' => 'The maximum outbound bandwidth to the Internet. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'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', 'title' => ''],
'KeyPairName' => ['description' => 'The name of the key pair.'."\n", 'type' => 'string', 'example' => 'test_01', 'title' => ''],
'Memory' => ['description' => 'The memory capacity of the instance. Unit: MiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8192', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'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****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'SerialNumber' => ['description' => 'The serial number of the instance.'."\n", 'type' => 'string', 'example' => 'b076f6ff-46d1-4234-a608-4e951ed6****', 'title' => ''],
'Status' => ['description' => 'The instance status. Valid values:'."\n"
."\n"
.'* **Pending**'."\n"
.'* **Running**'."\n"
.'* **Starting**'."\n"
.'* **Stopping**'."\n"
.'* **Stopped**'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1nt15muovrc5qdj****', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-2zeu747v4765aw2id****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID. ', 'type' => 'string', 'example' => 'rg-aeky6z354ks****', 'title' => ''],
'InstanceChargeType' => ['description' => 'Billing method. Valid values:'."\n"
.'* **PrePaid**: subscription'."\n"
.'* **PostPaid**: pay-as-you-go ', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''],
'DbType' => ['description' => 'The database type. Valid values:'."\n"
."\n"
.'- **mssql**: SQL Server'."\n"
.'- **mysql**: MySQL', 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'SpotStrategy' => ['description' => 'The spot strategy for pay-as-you-go instances. Valid values:'."\n"
."\n"
.'- **NoSpot**: Normal pay-as-you-go instance.'."\n"
.'- **SpotAsPriceGo**: The system automatically bids based on the current marketplace price.', 'type' => 'string', 'example' => 'NoSpot', 'title' => ''],
'SystemDisk' => [
'description' => 'System disk specifications. ',
'type' => 'object',
'properties' => [
'SystemDiskSize' => ['description' => 'System disk size, in GiB. ', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''],
'SystemDiskCategory' => ['description' => 'The system disk category. Valid values:'."\n"
."\n"
.'- **cloud_efficiency**: ultra disk.'."\n"
.'- **cloud_ssd**: standard SSD.'."\n"
.'- **cloud_essd**: enterprise SSD (ESSD).'."\n"
.'- **cloud_auto**: premium performance disk.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
'SystemDiskPerformanceLevel' => ['description' => 'Performance level of the system disk when it is an enterprise SSD (ESSD). Valid values:'."\n"
."\n"
.'- **PL0**'."\n"
.'- **PL1**'."\n"
.'- **PL2**'."\n"
.'- **PL3** ', 'type' => 'string', 'example' => 'PL1', 'title' => ''],
'DeleteWithInstance' => ['description' => 'A backup parameter.', 'type' => 'boolean', 'example' => 'None', 'title' => ''],
'Encrypted' => ['description' => 'Specifies whether to encrypt the disk. Valid values:'."\n"
."\n"
.'- **true**: Yes'."\n"
.'- **false**: No', 'type' => 'string', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'CreateMode' => ['description' => 'Indicates whether the instance is added to an ACK cluster. Valid values: '."\n"
."\n"
.'- **1**: Yes '."\n"
.'- **0**: No ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled for the instance. Valid values:'."\n"
."\n"
.'* **true**: Yes'."\n"
.'* **false**: No', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'DeletionProtection' => ['description' => 'Whether deletion protection is enabled. Valid values:'."\n"
.'* **true**: Enabled'."\n"
.'* **false**: Disabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Gpu' => ['description' => 'Number of GPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'GpuTypes' => ['description' => 'The GPU type.', 'type' => 'string', 'example' => 'NVIDIA V100', 'title' => ''],
'NodeType' => ['description' => 'The File Type. When the value is **rds_vnode**, it indicates that the node is a container node. ', 'type' => 'string', 'example' => 'rds_vnode', 'title' => ''],
'UserData' => ['description' => 'The custom data of the instance, formatted as a base64-encoded string.'."\n"
."\n"
.'> If the instance does not have custom data, an empty string is returned.', 'title' => 'User-defined data', 'type' => 'string', 'example' => 'IyEvYmluL3NoCmVjaG8gXCJIZWxsbyBXb3JsZC4gVGhlIHRpbWUgaXMgbm93ICQoZGF0ZSAtUikhXCIgfCB0ZWUgL3Jvb3QvdXNlcmRhdGFfdGVzdDA2MjB0d28udHh0'],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidInstanceName.CustomMalformed', 'errorMessage' => 'The instance name is invalid, please use valid format.', 'description' => 'Instance name format does not conform to specification'],
['errorCode' => 'InvalidDBInstanceName.MultipleFound', 'errorMessage' => 'The specified DB instance name matches multiple instances.', 'description' => 'The specified instance name matches more than one instance, please re-enter'],
['errorCode' => 'InvalidRCInstanceID.NotFound', 'errorMessage' => 'The specified custom instanceID is not valid.', 'description' => 'The passed instance ID does not belong to the custom instance.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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 \\"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 \\"EnableJumboFrame\\": false\\n}","type":"json"}]',
'title' => 'Query all property information of a single RDS Custom instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'DescribeRCInstanceDdosCount' => [
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DdosRegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'docRequired' => true, 'title' => ''],
],
],
'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-A854E3EF****_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', 'title' => ''],
'InstacenCount' => ['description' => 'The total number of instances.'."\n", 'type' => 'string', 'example' => '6', 'title' => ''],
'DefenseCount' => ['description' => 'The number of instances for which traffic scrubbing is triggered.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '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.',
'description' => '### [](#)Supported database engine'."\n"
."\n"
.'SQL Server'."\n"
."\n"
.'### [](#)References'."\n"
."\n"
.'[Introduction to ApsaraDB RDS Custom](~~2864363~~)'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCInstanceDdosCount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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******', 'title' => ''],
],
[
'name' => 'InstanceIp',
'in' => 'query',
'schema' => ['description' => 'The IP address of the asset to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '39.105.XXX.XXX', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of instances on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The type of the resource. Set the value to **ecs**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''],
],
[
'name' => 'DdosRegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'docRequired' => true, 'title' => ''],
],
[
'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******', 'title' => ''],
],
],
'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', 'title' => ''],
'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******', 'title' => ''],
'InstanceType' => ['description' => 'The type of the asset. The value is fixed to **ecs**.'."\n", 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'rc-kti8hw44yy0x53******', 'title' => ''],
'InstanceStatus' => ['description' => 'The DDoS mitigation status of the instance. Valid values:'."\n"
."\n"
.'* **normal**'."\n"
.'* **abnormal**'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''],
'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', 'title' => ''],
'IsBgppack' => ['description' => 'Indicates whether the asset is added to the instance. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IpVersion' => ['description' => 'The IP version of the instance. Valid values:'."\n"
."\n"
.'* **v4**'."\n"
.'* **v6**'."\n", 'type' => 'string', 'example' => 'v4', 'title' => ''],
'IpStatus' => ['description' => 'The DDoS mitigation status of the asset. Valid values:'."\n"
."\n"
.'* **mitigating**'."\n"
.'* **blackholed**'."\n"
.'* **normal**'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''],
'RegionId' => ['description' => 'The region code of the asset.'."\n", 'type' => 'string', 'example' => 'cn-beijing-wt97-a01', 'title' => ''],
'ElasticThreshold' => ['description' => 'The burstable protection threshold for the asset. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12310', 'title' => ''],
'BlackholeThreshold' => ['description' => 'The basic protection threshold for the asset. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5200', 'title' => ''],
'DefenseBpsThreshold' => ['description' => 'The traffic scrubbing threshold for the asset measured in Mbit/s. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300'."\n", 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCInstanceIpAddress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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, 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-e6e3757b8px27oa5****', 'docRequired' => true, 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:DescribeRCInstanceVncUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeRCInstances' => [
'summary' => 'You can invoke the DescribeRCInstances API to query the list of specified RDS Custom instances. If no instance ID (InstanceId) is specified, the API returns the list of all RDS Custom instances in the destination region. ',
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'docRequired' => true, 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-i2p26bde8bckf141****'."\n", 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Query by specified tag. The input format is: `{"TagKey":"TagValue"}`.', 'type' => 'string', 'required' => false, 'example' => '{"testRC":"test01"}', 'title' => ''],
],
[
'name' => 'PublicIp',
'in' => 'query',
'schema' => ['description' => 'Query by instance public IP address. ', 'type' => 'string', 'required' => false, 'example' => '121.89.XX.XX', 'title' => ''],
],
[
'name' => 'HostIp',
'in' => 'query',
'schema' => ['description' => 'Query by instance host IP address. ', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => 'Instance ID.'."\n"
."\n"
.'This parameter is used to query multiple instances simultaneously. Separate instance IDs with English commas (,), and up to 100 IDs are supported. The input format is: `["instance ID 1","instance ID 2"]`.'."\n"
."\n"
.'> When both **InstanceIds** and **instanceId** are provided, the value of **InstanceIds** takes precedence.', 'type' => 'string', 'required' => false, 'example' => '["rc-i2p26bde8bckf141****","rc-l1753m982otq2s2m****"]', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'Instance status. Valid values: '."\n"
."\n"
.'- **Pending**: Creation in progress. '."\n"
.'- **Running**: Running. '."\n"
.'- **Starting**: Starting. '."\n"
.'- **Stopping**: Pausing. '."\n"
.'- **Stopped**: Paused. ', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'Instance Name ', 'title' => '', 'type' => 'string', 'example' => 'k8s-node', 'required' => false],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', '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', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'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.16.XX.XX', 'title' => ''],
'HostName' => ['description' => 'The host name.'."\n", 'type' => 'string', 'example' => 'i-2zeaiz4g9u23f40m****', 'title' => ''],
'ClusterName' => ['description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'testrdscustom', 'title' => ''],
'DbType' => ['description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'rds_custom', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90****'."\n", 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-2ze704f*****'."\n", 'title' => ''],
'Description' => ['description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'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', 'title' => ''],
'InstanceChargeType' => ['description' => 'Billing method. Valid values: '."\n"
.'* **PrePaid**: subscription '."\n"
.'* **PostPaid**: pay-as-you-go ', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''],
'CreateMode' => ['description' => 'Indicates whether the instance can be added to an ACK cluster. When this parameter is set to **1**, the created instance can be added to an ACK cluster by using the **AttachRCInstances** API operation, enabling efficient management of container applications. '."\n"
."\n"
.'- **1**: Yes '."\n"
.'- **0** (default): No ', 'type' => 'string', 'example' => '0', 'title' => ''],
'ZoneId' => ['description' => 'Zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
'TagResources' => [
'description' => 'The queried instances and tag details. ',
'type' => 'array',
'items' => [
'description' => 'The queried instances and tag details. ',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => 'Resource ID. ', 'type' => 'string', 'example' => 'rc-t8q22a87745hf8******', 'title' => ''],
'ResourceType' => ['description' => 'Resource type. '."\n"
."\n"
.'- `ALIYUN::RDS::INSTANCE`: ApsaraDB RDS instance '."\n"
.'- `ALIYUN::RDS::CUSTOM`: RDS Custom instance ', 'type' => 'string', 'example' => 'ALIYUN::RDS::CUSTOM', 'title' => ''],
'TagKey' => ['description' => 'Tag key. ', 'type' => 'string', 'example' => 'testRC', 'title' => ''],
'TagValue' => ['description' => 'Tag value. ', 'type' => 'string', 'example' => 'test01', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'SpotStrategy' => ['description' => 'Spot strategy for pay-as-you-go instances. The return value is as follows: '."\n"
."\n"
.'- **NoSpot**: Normal pay-as-you-go instance. '."\n"
.'- **SpotAsPriceGo**: System automatically bids based on the current market price. ', 'type' => 'string', 'example' => 'NoSpot', 'title' => ''],
'Tags' => [
'description' => 'Tag Details. ',
'type' => 'array',
'items' => [
'description' => 'Tag Details. ',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => 'Resource ID.', 'type' => 'string', 'example' => 'rc-t8q22a87745hf8******', 'title' => ''],
'ResourceType' => ['description' => 'Resource type.'."\n"
."\n"
.'- `ALIYUN::RDS::INSTANCE`: ApsaraDB RDS instance '."\n"
.'- `ALIYUN::RDS::CUSTOM`: RDS Custom instance', 'type' => 'string', 'example' => 'ALIYUN::RDS::CUSTOM', 'title' => ''],
'TagKey' => ['description' => 'Tag key.', 'type' => 'string', 'example' => 'testRC', 'title' => ''],
'TagValue' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'test01', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PublicIp' => ['description' => 'Public IP address of the instance.', 'type' => 'string', 'example' => '121.89.XX.XX'."\n", 'title' => ''],
'InstanceType' => ['description' => 'Instance Type. '."\n"
."\n"
.'For more information, see [RDS Custom Instance Type List](~~2844823~~). ', 'type' => 'string', 'example' => 'mysql.x2.xlarge.6cm', 'title' => ''],
'InstanceTypeFamily' => ['description' => 'Instance family. '."\n"
."\n"
.'For more information, see [RDS Custom instance type list](~~2844823~~). ', 'type' => 'string', 'example' => 'x.6cm', 'title' => ''],
'SecurityGroupId' => ['description' => 'The security group ID. ', 'type' => 'string', 'example' => 'sg-2vcbcivwfxiozhtp****', 'title' => ''],
'Cpu' => ['description' => 'Number of vCPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'Memory' => ['description' => 'Memory size, in MiB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16384', 'title' => ''],
'ExpiredTime' => ['description' => 'Instance Expiration Time. It is represented in ISO 8601 format using UTC+0 time, with the pattern `yyyy-MM-ddTHH:mm:ssZ`. '."\n"
."\n"
.'> The expiration time displayed in the console is 8 hours later. ', 'type' => 'string', 'example' => '2025-05-02T16:00:00Z', 'title' => ''],
'DeploymentSetId' => ['description' => 'The deployment set ID.', 'type' => 'string', 'example' => 'ds-bp14k1xvolvsy4z3****', 'title' => ''],
'ImageId' => ['description' => 'Image ID. ', 'type' => 'string', 'example' => 'aliyun_3_x64_20G_alibase_20250117.vhd', 'title' => ''],
'VpcAttributes' => [
'description' => 'The virtual private cloud (VPC) attributes. ',
'type' => 'object',
'properties' => [
'NatIpAddress' => ['description' => 'Reserved parameter. ', 'type' => 'string', 'example' => 'None', 'title' => ''],
'PrivateIpAddress' => [
'description' => 'The private IP addresses. ',
'type' => 'array',
'items' => ['description' => 'A private IP address. ', 'type' => 'string', 'example' => '172.16.XX.XX', 'title' => ''],
'title' => '',
'example' => '',
],
'VSwitchId' => ['description' => 'The vSwitch ID. ', 'type' => 'string', 'example' => 'vsw-bp1nb3pv03878tgnj****', 'title' => ''],
'VpcId' => ['description' => 'The virtual private cloud (VPC) ID. ', 'type' => 'string', 'example' => 'vpc-uf6f7l4fg90****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'NodeType' => ['description' => 'File Type. When **rds_vnode** is returned, it indicates that the node is a container node. ', 'type' => 'string', 'example' => 'rds_vnode', 'title' => ''],
'InstanceName' => ['description' => 'Instance name ', 'title' => '', 'type' => 'string', 'example' => 'k8s-node'],
'StoppedMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'OSName' => ['type' => 'string', 'example' => 'CentOS 7.4 64 位', 'description' => '', 'title' => ''],
'OSType' => ['type' => 'string', 'example' => 'linux', 'description' => '', 'title' => ''],
'StartTime' => ['type' => 'string', 'example' => '2017-12-10T04:04Z', 'description' => '', 'title' => ''],
'EcsHostName' => ['type' => 'string', 'example' => 'testHostName', 'description' => '', 'title' => ''],
'AutoRenew' => ['type' => 'boolean', 'title' => '', 'description' => '', 'example' => ''],
],
'description' => 'Detailed instance information. ',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidParameter.InstanceIds', 'errorMessage' => 'The specified parameter InstanceIds is invalid.', 'description' => 'InstanceIds is invalid.'],
['errorCode' => 'InvalidDBInstanceName.MultipleFound', 'errorMessage' => 'The specified DB instance name matches multiple instances.', 'description' => 'The specified instance name matches more than one instance, please re-enter'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The specified instance does not exist or is not supported.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query the list of RDS Custom instances ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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 \\"AutoRenew\\": false\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRCMetricList' => [
'summary' => 'This API is used to query the monitoring data of a specified metric for a target 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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Express',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => '6178f1825f9fb76ce0b5e8707e******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', 'title' => ''],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => ['description' => 'Custom for SQL Server to batch query monitoring data for specified resources. '."\n"
.'Format: a collection of key:value pairs.', 'type' => 'string', 'required' => false, 'example' => '[{"instanceId":"rc-l9hv3rv74ql7oa******"},{"instanceId":"rc-b532l1uj8n6sex******"}]', 'title' => ''],
],
],
'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', 'title' => ''],
'Datapoints' => ['description' => 'The monitoring data.'."\n", 'type' => 'string', 'example' => '[{\\"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}]', 'title' => ''],
'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', 'title' => ''],
'NextToken' => ['description' => 'The pagination token.'."\n", 'type' => 'string', 'example' => '6178f1825f9fb76ce0b5e8707e******', 'title' => ''],
'Period' => ['description' => 'The statistical period of the monitoring data.'."\n", 'type' => 'string', 'example' => '60', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'View Monitoring Data of an RDS Custom Instance ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:DescribeRCMetricList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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, 'title' => ''],
],
[
'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, 'title' => ''],
],
[
'name' => 'NodePoolId',
'in' => 'query',
'schema' => ['description' => 'The node pool ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", 'title' => ''],
],
],
'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", 'title' => ''],
'NodePoolId' => ['description' => 'The node pool ID.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", 'title' => ''],
'SecurityEnhancementStrategy' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'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', 'title' => ''],
'DeleteWithInstance' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'example' => 'None', 'title' => ''],
'Encrypted' => ['description' => 'Indicates whether to encrypt the cloud disk. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''],
'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', 'title' => ''],
'Size' => ['description' => 'The data disk size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Testvalue1'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DeploymentSetId' => ['description' => 'The ID of the deployment set.'."\n", 'type' => 'string', 'example' => 'ds-bp18ukv66rlyuffv****', 'title' => ''],
'Description' => ['description' => 'The instance description.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'Password' => ['description' => 'The password of the root user of the instance.'."\n", 'type' => 'string', 'example' => 'testPassword'."\n", 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-zm0qvgv3sm3sjzbkr****', 'title' => ''],
'HostName' => ['description' => 'The instance hostname.'."\n", 'type' => 'string', 'example' => 'testHost1'."\n", 'title' => ''],
'InternetChargeType' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'ImageId' => ['description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'example' => 'image-dsvjzw2ii8n4fvr****', 'title' => ''],
'InstanceType' => ['description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'mysql.i8.large.2cm', 'title' => ''],
'InternetMaxBandwidthOut' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'None', 'title' => ''],
'IoOptimized' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'KeyPairName' => ['description' => 'The key pair name.'."\n", 'type' => 'string', 'example' => 'dell5502', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'SecurityGroupId' => ['description' => 'The security group ID.'."\n", 'type' => 'string', 'example' => 'sg-uf6av412xaxixuez****', 'title' => ''],
'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', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmy****', 'title' => ''],
'InstanceChargeType' => ['description' => 'The billing method. Valid value:'."\n"
."\n"
.'* **Prepaid**: subscription'."\n"
.'* **Postpaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'Prepaid', 'title' => ''],
'SpotStrategy' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'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', 'title' => ''],
'Size' => ['description' => 'The size of the system disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'CreateMode' => ['description' => 'Indicates whether to add the instance to the ACK cluster.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'Period' => ['description' => 'The subscription duration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PeriodUnit' => ['description' => 'The unit of the subscription period. Valid values:'."\n"
."\n"
.'* **Year**'."\n"
.'* **Month** (default)'."\n", 'type' => 'string', 'example' => 'Year', 'title' => ''],
'AutoRenew' => ['description' => 'Indicates whether to enable auto-renewal for the instance. Valid values:'."\n"
."\n"
.'* **true** (default)'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'NodePoolName' => ['description' => 'The name of the node pool.'."\n", 'type' => 'string', 'example' => 'np31da1b38983f4511b490fc62108a****'."\n", 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribeRCNodePool',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:DescribeRCNodePool',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeRCSnapshots' => [
'summary' => 'This API is used to query snapshot list information, such as snapshot status, the remaining time for a snapshot being created to complete, and the number of days automatic snapshots are retained.',
'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****', 'title' => ''],
],
[
'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****"]', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'maxItems' => 21,
'description' => 'Tag Details.',
'type' => 'array',
'items' => [
'description' => 'Tag Details.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testRC'."\n", 'title' => ''],
'Value' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Description' => ['description' => 'The snapshot description.'."\n", 'type' => 'string', 'example' => 'zd_test', 'title' => ''],
'Encrypted' => ['description' => 'Indicates whether the snapshot was encrypted. Valid values:'."\n"
."\n"
.'* true'."\n"
.'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'InstantAccess' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'example' => 'none', 'title' => ''],
'Progress' => ['description' => 'The progress of the snapshot creation task in percentage.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'SnapshotId' => ['description' => 'The snapshot ID.'."\n", 'type' => 'string', 'example' => 'rcds-hc1zg51xobdg4****', 'title' => ''],
'SnapshotName' => ['description' => 'The snapshot name.'."\n", 'type' => 'string', 'example' => 'csw-37-系统盘', 'title' => ''],
'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', 'title' => ''],
'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****', 'title' => ''],
'SourceDiskSize' => ['description' => 'The storage capacity of the original disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'SourceDiskType' => ['description' => 'The type of the original disk. Valid values:'."\n"
."\n"
.'* SYSTEM: system disk'."\n"
.'* DATA: data disk'."\n", 'type' => 'string', 'example' => 'data', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ResourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => 'rc-t8q22a87745hf8****', 'title' => ''],
'LastModifiedTime' => ['title' => 'Last modification time of the snapshot. Represented in ISO 8601 standard using UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'description' => '', 'example' => ''],
'Tag' => [
'description' => 'Tag Details. ',
'type' => 'array',
'items' => [
'description' => 'Tag Details. ',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'tag key. ', 'type' => 'string', 'example' => 'testRC', 'title' => ''],
'TagValue' => ['description' => 'tag value. ', 'type' => 'string', 'example' => 'test01', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'SDK.InvalidRegionId', 'errorMessage' => 'Can not find endpoint to access.', 'description' => 'Cannot find endpoint to access.'],
['errorCode' => 'InvalidParameter.SnapshotIds', 'errorMessage' => 'The specified parameter SnapshotIds is invalid.', 'description' => 'The specified snapshot parameters are invalid'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query snapshot list ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCSnapshots'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRCSnapshots',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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',
'title' => '',
],
],
],
'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', 'title' => ''],
'IsTop' => ['description' => 'Specifies whether to pin the notification at the top.'."\n"
."\n"
.'* true'."\n"
.'* false'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'NoticeBarContent' => ['description' => 'The notification text.'."\n", 'type' => 'string', 'example' => '系统将于今晚十点进行维护,届时可能会短暂影响服务。', 'title' => ''],
'PoppedUpButtonText' => ['description' => 'The text of the popup button.'."\n", 'type' => 'string', 'example' => '立即订阅。', 'title' => ''],
'PoppedUpButtonType' => ['description' => 'The type of the popup button.'."\n"
."\n"
.'* BUY'."\n"
.'* RENEW'."\n"
.'* UPGRADE'."\n", 'type' => 'string', 'example' => '新购:BUY', 'title' => ''],
'PoppedUpButtonUrl' => ['description' => 'The link of the popup button.'."\n", 'type' => 'string', 'example' => 'https://www.example.com/subscribe', 'title' => ''],
'PoppedUpContent' => ['description' => 'The text of the popup.'."\n", 'type' => 'string', 'example' => '获得最新更新和新闻,通过订阅我们的通知,确保您永远不会错过任何重要消息。', 'title' => ''],
'ResourceNiche' => ['description' => 'The location of the notification.'."\n", 'type' => 'string', 'example' => 'noticeBar(通知栏)', 'title' => ''],
'StartDate' => ['description' => 'The effective date.'."\n", 'type' => 'string', 'example' => '2024-04-21', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '76364A52-E0AB-5CC8-xxxx-CF1DC482C092', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsResourceSettings'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRdsResourceSettings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The primary instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp****', 'title' => ''],
'DelayTime' => ['description' => 'The latency of data replication. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'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****', 'title' => ''],
'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' => '"ReadDBInstanceName": ["rr-bp****"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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' => '"ReadDelayTime": ["0"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'FlushLatency' => ['description' => 'The data size that is allowed for the latency in the persistence of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'ReadDBInstanceName' => ['description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rr-bp****', 'title' => ''],
'ReplayLag' => ['description' => 'The duration that is allowed for the latency in the playback of WAL data. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'ReplayLatency' => ['description' => 'The data size that is allowed for the latency in the playback of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'SendLatency' => ['description' => 'The data size that is allowed for the latency in the sending of WAL data. Unit: MB.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'WriteLag' => ['description' => 'The duration that is allowed for the latency in the write-back of WAL data. Unit: seconds.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ReadDBInstanceId' => ['description' => 'The read-only instance ID.'."\n", 'type' => 'string', 'example' => 'rr-bp****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F1BDDEA8-452D-450B-AB10-CD5C5BAFC5DF', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', 'description' => 'The read-only RDS instance is not created, or the values of the request parameters are invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-08-06T11:52:26.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-17T01:27:44.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeReadDBInstanceDelay'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeReadDBInstanceDelay',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5414A4E5-4C36-4461-95FC-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvaildEngineInRegion.NotAvailable', 'errorMessage' => 'The Engine in the Region is not available.', 'description' => 'The database engine is not supported in the region.'],
['errorCode' => 'OperationDenied', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Insufficient resources. Contact on-duty engineers to increase the inventory.'],
['errorCode' => 'RegionUnauthorized', 'errorMessage' => 'There is no authority to create instance in the specified region.', 'description' => 'RDS instances cannot create in this region. Specify a different region and try again.'],
['errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', 'description' => 'The maximum number of instances has been exceeded. Release the instances that are no longer needed.'],
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist in our records.', 'description' => 'The region ID cannot be found. Check the region ID.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-08-09T11:30:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegionInfos'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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', 'title' => ''],
],
],
'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)', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
'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 J', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidAcceptLanguage.NotFound', 'errorMessage' => 'Only Chinese (zh-CN) and English (en-US) are allowed.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => ['description' => 'The type of order. Set the value to **BUY**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'RENEW', 'title' => ''],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '121436975448952', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'ErrorCode' => ['description' => 'The error code that is returned.'."\n", 'type' => 'string', 'example' => ' 123456', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'Description' => ['description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'IsSelected' => ['description' => 'Indicates whether the coupon is selected.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'Name' => ['description' => 'The name of the coupon.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'Currency' => ['description' => 'The currency unit.'."\n", 'type' => 'string', 'example' => 'CNY', 'title' => ''],
'DiscountPrice' => ['description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '27', 'title' => ''],
'OriginalPrice' => ['description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '138', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'TradePrice' => ['description' => 'The transaction price, which is equal to the original price minus the discount.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '111', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DC9F4EF6-D038-4405-B497-1F48E722C9F2', 'title' => ''],
'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' => 'Activity Description', 'title' => ''],
'Name' => ['description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'RuleId' => ['description' => 'The ID of the promotion rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1001199213', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SYSTEM.SaleValidateFailed', 'errorMessage' => 'The request not refer to the correct order period. please check your Period or UsedTime param.', 'description' => ''],
['errorCode' => 'OrdQueryAccountError', 'errorMessage' => 'Error calling account service.', 'description' => ''],
['errorCode' => 'Price.WanHuaTong.sys', 'errorMessage' => 'Inquiry error.', 'description' => ''],
['errorCode' => 'DBNodeParameter.Required', 'errorMessage' => 'The specified parameter DBNode is required.', 'description' => 'You must specify the DBNode parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-07-11T03:20:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-21T09:58:40.000Z', 'description' => 'Request parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeRenewalPrice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '30', 'title' => ''],
],
],
'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****', 'title' => ''],
'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*', 'title' => ''],
'GmtCreated' => ['description' => 'The creation time. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-02-25T06:57:41Z', 'title' => ''],
'GmtModified' => ['description' => 'The modification time. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-03-01T06:39:51Z', 'title' => ''],
'ReplicationInfo' => ['description' => 'The synchronization information. This parameter is a reserved parameter.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'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', 'title' => ''],
'ReplicatorAccount' => ['description' => 'The account of the database that is used for data synchronization.'."\n", 'type' => 'string', 'example' => 'testdbuser'."\n", 'title' => ''],
'ReplicatorPassword' => ['description' => 'The password of the account.'."\n", 'type' => 'string', 'example' => 'testpassword'."\n", 'title' => ''],
'SourceAddress' => ['description' => 'The endpoint of the source instance.'."\n", 'type' => 'string', 'example' => 'pgm-****.pg.rds.aliyuncs.com'."\n", 'title' => ''],
'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', 'title' => ''],
'SourcePort' => ['description' => 'The port number of the source instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5432', 'title' => ''],
'TargetInstanceId' => ['description' => 'The destination instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1l4dutw453****', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8413252', 'title' => ''],
'TaskName' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'test01', 'title' => ''],
'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', 'title' => ''],
'TaskStatus' => ['description' => 'The status of the task. Valid values:'."\n"
."\n"
.'* **success**'."\n"
.'* **failure**'."\n"
.'* **running**'."\n", 'type' => 'string', 'example' => 'success ', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidTaskType', 'errorMessage' => 'specified task type is invalid.', 'description' => 'The specified task type is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-08-19T03:02:13.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeReplicationLinkLogs'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeReplicationLinkLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DescribeResourceDetails' => [
'summary' => 'Resource details on the overview page ',
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1ul2y10grt91m68', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3kyoa2wqhyy', 'title' => ''],
],
],
'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', 'title' => ''],
'BackupLogSize' => ['description' => 'The size of the backup log. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21183797', 'title' => ''],
'BackupSize' => ['description' => 'The size of the backup data. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '53002759', 'title' => ''],
'DbInstanceStorage' => ['description' => 'The disk capacity of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''],
'DbProxyInstanceName' => ['description' => 'The name of the proxy instance.'."\n", 'type' => 'string', 'example' => 'mr-n1m1wjrylfolvrt67s', 'title' => ''],
'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', 'title' => ''],
'InstanceStorageType' => ['description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
'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', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n"
."\n"
.'> The vSwitch must belong to the same zone as the instance.'."\n", 'type' => 'string', 'example' => 'vsw-2zelwi1jd271p670lzl8h', 'title' => ''],
'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-wz9rbibex7v0lxbeyo6at', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query resource details',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceDetails'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeResourceDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => ' rm-uf6wjk5******', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F937E173-559C-4498-8D90-38D32342B9E4', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => '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' => ' ',
'changeSet' => [
['createdAt' => '2025-01-09T11:43:43.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-05-22T07:06:34.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-04T09:19:51.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceUsage'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeResourceUsage',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'SQLCollectorStatus' => ['description' => 'The status of the SQL Explorer (SQL Audit) feature. Valid values:'."\n"
."\n"
.'* **Enable**'."\n"
.'* **Disabled**'."\n", 'type' => 'string', 'example' => 'Enable', 'title' => ''],
'StoragePeriod' => ['description' => 'A reserved parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
504 => [
['errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => 'Request failed due to timeout processing'],
],
],
'title' => 'DescribeSQLCollectorPolicy',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-15T07:38:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-18T06:44:20.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:26:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLCollectorPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSQLCollectorPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D5CEDCC2-CA75-43F7-9508-92F418CE6391', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidComment', 'errorMessage' => 'Should specify a policy name.', 'description' => 'The name of the policy is left unspecified.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigValue\\": \\"365\\",\\n \\"RequestId\\": \\"D5CEDCC2-CA75-43F7-9508-92F418CE6391\\"\\n}","errorExample":""},{"type":"xml","example":"\\n365\\nD5CEDCC2-CA75-43F7-9508-92F418CE6391\\n","errorExample":""}]',
'title' => 'DescribeSQLCollectorRetention',
'description' => '### [](#)Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLCollectorRetention'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSQLCollectorRetention',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeSQLLogFiles' => [
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => 'The name of the audit log file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'custins****.csv', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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' => 'custins****.csv', 'title' => ''],
'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/****', 'title' => ''],
'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', 'title' => ''],
'LogSize' => ['description' => 'The size of the audit log file. Unit: bytes.'."\n", 'type' => 'string', 'example' => '3000', 'title' => ''],
'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', 'title' => ''],
'LogStatus' => ['description' => 'The status of the audit log file. Valid values:'."\n"
."\n"
.'* **Success**'."\n"
.'* **Failed**'."\n"
.'* **Generating**'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => ' 1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
504 => [
['errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => 'Request failed due to timeout processing'],
],
],
'title' => '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.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-07-11T05:31:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-11T08:59:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-27T07:31:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLLogFiles'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSQLLogFiles',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'SQLId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the SQL statement.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-06T15:00:00Z', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'DBName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'testDB', 'title' => ''],
'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', 'title' => ''],
'HostAddress' => ['description' => 'The IP address of the client that is connected to the instance.'."\n", 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''],
'ReturnRowCounts' => ['description' => 'The number of SQL audit log entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'SQLText' => ['description' => 'The SQL statement.'."\n", 'type' => 'string', 'example' => 'update test.zxb set id=0 limit 1', 'title' => ''],
'ThreadID' => ['description' => 'The thread ID.'."\n", 'type' => 'string', 'example' => '1025865428', 'title' => ''],
'TotalExecutionTimes' => ['description' => 'The execution duration of the SQL statement. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of SQL audit log entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidQueryTimeRange', 'errorMessage' => 'The query time range is invalid.', 'description' => 'Invalid query time range'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
504 => [
['errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => 'Request failed due to timeout processing'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-07-09T13:35:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T03:57:55.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogRecords'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSQLLogRecords',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'SQLExecuteTimes' => ['description' => 'The number of times that the SQL statement is executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
'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;', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'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;', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of SQL log reports on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828 ', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-27T07:31:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLLogReportList'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSQLLogReportList',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeSQLServerUpgradeVersions' => [
'summary' => 'Describes the versions to which an SQL Server instance or a specified SQL Server version can be upgraded.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'This parameter ensures the idempotence of the request to prevent duplicate submissions. The value is generated by the client and must be unique across different requests.'."\n"
."\n"
.'The value consists of ASCII characters, contains no more than 64 characters, and must not include non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOC****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID. You can obtain it by invoking DescribeDBInstances.', 'type' => 'string', 'required' => false, 'example' => 'rm-xx1xxx2****'."\n", 'title' => ''],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'Database version to query. If instanceId is specified, the instance\'s version overwrites this parameter.', 'type' => 'string', 'required' => false, 'example' => '2016_web', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Items' => [
'items' => [
'type' => 'object',
'properties' => [
'CurrentVersion' => ['name' => 'CurrentVersion', 'description' => '当前的版本。若传DBInstanceId,则返回实例版本。若未传DBInstanceId,但传了EngineVersion,则返回EngineVersion。', 'type' => 'string', 'example' => '2016_web', 'backendName' => 'currentVersion'],
'SQLServerUpgradeVersions' => [
'name' => 'SQLServerUpgradeVersions',
'description' => '一个列表,显示是否支持升级到目标版本',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DBInstanceClassItems' => [
'name' => 'DBInstanceClassItems',
'description' => '一个列表,描述了每个版本是否可以成为升级目标',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CPU' => ['name' => 'CPU', 'description' => '可升级的版本规格的CPU大小', 'type' => 'string', 'example' => '2', 'backendName' => 'cpu'],
'DBInstanceClass' => ['name' => 'DBInstanceClass', 'description' => '可升级的版本规格', 'type' => 'string', 'example' => 'mssql.x4.medium.s2', 'backendName' => 'dbInstanClass'],
'DBInstanceClassType' => ['name' => 'DBInstanceClassType', 'description' => '可升级的版本规格的类型', 'type' => 'string', 'example' => '独享型', 'backendName' => 'groupName'],
'Group' => ['name' => 'Group', 'description' => '组类型', 'type' => 'string', 'example' => '2', 'backendName' => 'group'],
'Memory' => ['name' => 'Memory', 'description' => '可升级的版本规格的内存大小', 'type' => 'string', 'example' => '8GB', 'backendName' => 'memory'],
],
'extendType' => 'true',
],
'backendName' => 'dbInstanceClassList',
'itemName' => 'DBInstanceClassItem',
],
'EnableUpgrade' => ['name' => 'EnableUpgrade', 'description' => '是否支持升级到该版本', 'type' => 'string', 'example' => 'NO/YES', 'backendName' => 'enable'],
'Version' => ['name' => 'Version', 'description' => '版本值', 'type' => 'string', 'example' => '2016_std', 'backendName' => 'version'],
],
'extendType' => 'true',
],
'backendName' => 'targetVersions',
'itemName' => 'SQLServerUpgradeVersion',
],
],
'extendType' => 'true',
],
'type' => 'object',
'description' => '',
'properties' => [
'Item' => [
'description' => 'Returned data',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentVersion' => ['description' => 'The current Version. If DBInstanceId is provided, the instance Version is returned. If DBInstanceId is not provided but EngineVersion is specified, EngineVersion is returned.', 'type' => 'string', 'example' => '2016_web', 'title' => ''],
'SQLServerUpgradeVersions' => [
'itemNode' => true,
'description' => '',
'type' => 'object',
'properties' => [
'SQLServerUpgradeVersion' => [
'description' => 'A list indicating whether upgrading to the target version is supported',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceClassItems' => [
'itemNode' => true,
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceClassItem' => [
'description' => 'A list that describes whether each version can be an upgrade target.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CPU' => ['description' => 'CPU size of the upgradable Edition Specifications', 'type' => 'string', 'example' => '2', 'title' => ''],
'DBInstanceClass' => ['description' => 'The edition specifications that can be upgraded.', 'type' => 'string', 'example' => 'mssql.x4.medium.s2', 'title' => ''],
'DBInstanceClassType' => ['description' => 'The type of the edition specifications that can be upgraded.', 'type' => 'string', 'example' => '独享型', 'title' => ''],
'Group' => ['description' => 'The group type.', 'type' => 'string', 'example' => '2', 'title' => ''],
'Memory' => ['description' => 'Memory size of the upgradable Edition Specifications', 'type' => 'string', 'example' => '8GB', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'EnableUpgrade' => ['description' => 'Indicates whether upgrading to this version is supported', 'type' => 'string', 'example' => 'NO/YES', 'title' => ''],
'Version' => ['description' => 'Version value', 'type' => 'string', 'example' => '2016_std', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'itemNode' => true,
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '866F5EB8-4650-4061-87F0-379F6F******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query SQL Server upgradable versions',
'description' => 'Supported engine: '."\n"
.'* SQL Server (supports only 2016 and earlier versions)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'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"}]',
'translator' => 'machine',
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-xjkljj****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''],
],
[
'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***', 'title' => ''],
],
],
'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', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'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****', 'title' => ''],
'Description' => ['description' => 'The description of the credential.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'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****', 'title' => ''],
'SecretName' => ['description' => 'The name of the credential.'."\n", 'type' => 'string', 'example' => 'Foo', 'title' => ''],
'Username' => ['description' => 'The username that is used to access the database.'."\n", 'type' => 'string', 'example' => 'user_jack', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-01-22T10:07:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-08-01T15:09:34.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecrets'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSecrets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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-uf6wjk****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The details of the response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk****', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'SecurityGroupId' => ['description' => 'The ID of the ECS security group.'."\n", 'type' => 'string', 'example' => 'sg-****', 'title' => ''],
'SecurityGroupName' => ['description' => 'The security group name.'."\n", 'type' => 'string', 'example' => 'security-group-emraccess', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '87BDAE8C-ACB0-4A26-BBCC-7D1DD31D630D', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-12-13T08:17:12.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityGroupConfiguration'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSecurityGroupConfiguration',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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', 'title' => ''],
'Plugin' => [
'description' => 'The extension used by the replication slot.'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'test_decoding',
'title' => '',
],
'SlotName' => ['description' => 'The replication slot name.'."\n", 'type' => 'string', 'example' => 'slot_test01', 'title' => ''],
'SlotStatus' => [
'description' => 'The replication slot status. Valid values:'."\n"
."\n"
.'* ACTIVE'."\n"
.'* INACTIVE'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'INACTIVE',
'title' => '',
],
'SlotType' => [
'description' => 'The replication slot type. Valid values:'."\n"
."\n"
.'* physical'."\n"
.'* logical'."\n",
'type' => 'string',
'enumValueTitles' => [],
'example' => 'logical',
'title' => '',
],
'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', 'title' => ''],
'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',
'title' => '',
],
'WalDelay' => ['description' => 'The number of logs accumulated in the replication slot.'."\n", 'type' => 'string', 'example' => '16 MB', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-08-14T12:03:56.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-04-10T08:27:24.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlots'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSlots',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeSlowLogRecords' => [
'summary' => 'This API is used to view the slow query 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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testdb', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'Engine' => ['description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'testDB', 'title' => ''],
'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', 'title' => ''],
'HostAddress' => ['description' => 'The name and IP address of the client that is connected to the database.'."\n", 'type' => 'string', 'example' => '****[****] @ [1XX.XX.XX.XX]', 'title' => ''],
'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', 'title' => ''],
'LockTimes' => ['description' => 'The lock duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'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', 'title' => ''],
'ParseRowCounts' => ['description' => 'The number of parsed rows.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'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', 'title' => ''],
'QueryTimeMS' => ['description' => 'The execution duration of the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2001', 'title' => ''],
'QueryTimes' => ['description' => 'The execution duration of the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'ReturnRowCounts' => ['description' => 'The number of rows returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'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', 'title' => ''],
'SQLHash' => ['description' => 'The unique ID of the SQL statement.'."\n", 'type' => 'string', 'example' => 'U2FsdGVk****', 'title' => ''],
'SQLText' => ['description' => 'The details of the SQL statement.'."\n", 'type' => 'string', 'example' => 'select sleep(2)', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'LockTimeMS' => ['description' => 'Lock duration. Unit: milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '2001', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of SQL log reports on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4DBB1BB0-E5D8-4D41-B1C9-142364DB****', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', 'description' => 'The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters.'],
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
408 => [
['errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', 'description' => 'Request timed out, please try again or narrow the time range'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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\\": 2001\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 1,\\n \\"RequestId\\": \\"4DBB1BB0-E5D8-4D41-B1C9-142364DB****\\",\\n \\"TotalRecordCount\\": 1\\n}","type":"json"}]',
'title' => 'View Slow Query Log Details ',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB'."\n"
."\n"
.'### Notes'."\n"
."\n"
.'- The response parameters of this API are updated once per minute.'."\n"
.'- When you invoke this API to pull data, a certain latency will occur. Please wait patiently for the response.'."\n"
.'- Starting from September 1, 2024, due to optimization of the SQL templating algorithm, the value of the SQLHash field will change when you call this API. For more information, see [【Notifications】Optimization of the Templating Algorithm for Slow SQL Statements](~~2845725~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-06-06T02:54:53.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-02T05:59:54.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'translator' => 'machine',
],
'DescribeSlowLogs' => [
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RDS_MySQL', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'EndTime' => ['description' => 'The end date of the query.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'SQLServer', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'CreateTime' => ['description' => 'The date when the data was generated.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', 'title' => ''],
'DBName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'ceshi', 'title' => ''],
'MaxExecutionTime' => ['description' => 'The longest execution duration of a specific SQL statement in the query. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'MaxExecutionTimeMS' => ['description' => 'The longest execution duration of a specific SQL statement in the query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ParseTotalRowCounts' => ['description' => 'The total number of rows that were parsed by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'ReportTime' => ['description' => 'The date on which the data report was generated.'."\n", 'type' => 'string', 'example' => '2011-05-30Z', 'title' => ''],
'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', 'title' => ''],
'ReturnTotalRowCounts' => ['description' => 'The total number of rows that were returned by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'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' => 'U2FsdGVk****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SQLText' => ['description' => 'The SQL statement that was executed in the query.'."\n", 'type' => 'string', 'example' => 'select id,name from tb_table', 'title' => ''],
'SlowLogId' => ['description' => 'The ID of the slow query log summary.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '26584213', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'TotalRowsAffectedCounts' => ['description' => 'The total number of rows that were affected by all SQL statements in the query.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of SQL statements that are returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2553A660-E4EB-4AF4-A402-8AFF70A49143', 'title' => ''],
'StartTime' => ['description' => 'The start date of the query.'."\n", 'type' => 'string', 'example' => '2011-05-01Z', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries that are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSearchTimeRange', 'errorMessage' => 'search time range cannot be longer than a month.', 'description' => 'The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters.'],
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'SortKey.ValueNotSupported', 'errorMessage' => 'SortKey.ValueNotSupported', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
408 => [
['errorCode' => 'RequestTimeout', 'errorMessage' => 'Query timed out.Please try again or narrow down the query scope.', 'description' => 'Request timed out, please try again or narrow the time range'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'DescribeSlowLogs',
'summary' => 'Queries the statistics on slow query logs.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-05-24T08:22:54.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogs'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSlowLogs',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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-bp****', 'title' => ''],
],
],
'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' => '200', 'title' => ''],
'Data' => ['description' => 'The response result set.'."\n", 'type' => 'string', 'example' => '{'."\n"
.' "SupportOnlineResizeDisk": true,'."\n"
.' "DBInstanceName": "rm-bp****",'."\n"
.' "maxSupportDiskSizeGB": 6144'."\n"
.'}', 'title' => ''],
'Message' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSupportOnlineResizeDisk'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeSupportOnlineResizeDisk',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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”}', 'title' => ''],
],
[
'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',
'title' => '',
],
],
],
'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****', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key1', 'title' => ''],
'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Tag.NoRegionIdExist', 'errorMessage' => 'the region Id can not be blank.', 'description' => 'The RegionId parameter cannot be empty. Specify this parameter.'],
['errorCode' => 'Tag.NoTagInfoExist', 'errorMessage' => 'all the tags and tagN parameters is null.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Tag.TagKeyCanNotBeAll', 'errorMessage' => 'tag key can not be all.', 'description' => 'The operation failed. Check the value of the TagKey parameter.'],
['errorCode' => 'Tag.TagKeyDuplex', 'errorMessage' => 'tag key must be sole in one operation.', 'description' => 'The tag has been added to the RDS instance. Define a different tag.'],
['errorCode' => 'Tag.NoDBInstanceIdExist', 'errorMessage' => 'the dbinstance Id can not be blank.', 'description' => 'The database instance ID must not be empty.'],
['errorCode' => 'Tag.TooManyDBInstanceIds', 'errorMessage' => 'the dbinstance Ids is more than 30.', 'description' => 'The number of database instance ID must not exceed 30.'],
['errorCode' => 'Tag.TooManyTagsForOneInstance', 'errorMessage' => 'total 10 tags can be added to one resource.', 'description' => 'The number of tags exceeds the maximum number of tags that is allowed. The maximum number is 10.'],
['errorCode' => 'Tag.Allow5TagInfos', 'errorMessage' => 'only 5 tags allowed in one operation.', 'description' => 'The operation failed. You can specify up to five tags at a time.'],
['errorCode' => 'Tag.TagKeyIsBlank', 'errorMessage' => 'tag key can not be blank.', 'description' => 'The tag is invalid. The key of the tag cannot be left unspecified.'],
['errorCode' => 'Tag.TagKeyStartWith.aliyun', 'errorMessage' => 'tag key and value can not be started with aliyun.', 'description' => 'The tag is invalid. The key of the tag cannot start with aliyun.'],
['errorCode' => 'Tag.TagKeyTooLong', 'errorMessage' => 'the max length of tag key is 64.', 'description' => ''],
['errorCode' => 'Tag.TagValueTooLong', 'errorMessage' => 'the max length of tag value is 128.', 'description' => ''],
['errorCode' => 'Tag.Malformed', 'errorMessage' => 'The specified parameter Tag is not valid.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Tag.SetTagInfoAtTwoParameter', 'errorMessage' => 'only tags or tagN parameter could be setted.', 'description' => 'The settings of the tag are invalid.'],
['errorCode' => 'Tag.InvalidTagsParameter', 'errorMessage' => 'tags parameter is invalid.', 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created and whether the RDS instance has not been deleted.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","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' => ' ',
'changeSet' => [
['createdAt' => '2022-11-14T02:07:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeTags',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'The status of the task. This parameter is invalid.'."\n", 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'TaskAction',
'in' => 'query',
'schema' => ['description' => 'The operation that is used by the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CreateInstance', 'title' => ''],
],
],
'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', 'title' => ''],
'CurrentStepName' => ['description' => 'The name of the subtask.'."\n", 'type' => 'string', 'example' => 'create_instance', 'title' => ''],
'DBName' => ['description' => 'The name of the database. If the task involves a database, the database name is returned.'."\n", 'type' => 'string', 'example' => 'DBtest', 'title' => ''],
'ExpectedFinishTime' => ['description' => 'The estimated end time of the task.'."\n"
."\n"
.'> In most cases, this parameter is empty.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'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', 'title' => ''],
'Progress' => ['description' => 'The task progress in percentage.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Status' => ['description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''],
'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', 'title' => ''],
'StepsInfo' => ['description' => 'The details of the subtasks.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''],
'TaskAction' => ['description' => 'The operation that is used by the task, such as **CreateDBInstance**.'."\n", 'type' => 'string', 'example' => 'CreateDBInstance', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'TaskId' => ['description' => 'The task ID. You can use one of the following methods to obtain the task ID:'."\n", 'type' => 'string', 'example' => '3472xxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A103039D-B1B2-4C57-B989-7D7C0DA95426', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IO.Exception', 'errorMessage' => 'IO exception, retry later.', 'description' => 'An I/O error occurred.'],
['errorCode' => 'InvokeServiceFailed', 'errorMessage' => 'Invoke service failed, retry later.', 'description' => 'A request error occurred. Please try again later.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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 \\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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeTasks',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeUpgradeMajorVersionPrecheckTask' => [
'summary' => 'Use this API to retrieve the pre-upgrade check report for a major version upgrade of RDS MySQL and RDS 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 this ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp1c808s731l****', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- 30 (default)'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.'."\n"
."\n"
.'The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'TargetMajorVersion',
'in' => 'query',
'schema' => ['description' => 'The major engine version to which you want to upgrade the instance. This version must be later than the current major engine version of the instance.', 'type' => 'string', 'required' => false, 'example' => '12.0', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The ID of the pre-upgrade check task. The UpgradeDBInstanceMajorVersionPrecheck operation returns this ID in the **TaskId** parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '416980000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1586777-41B5-5F9E-81E8-93DFDD379024', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of precheck reports.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Items' => [
'description' => 'The properties of the major version upgrade precheck report.',
'type' => 'array',
'items' => [
'description' => 'The details of the major version upgrade precheck report.',
'type' => 'object',
'properties' => [
'TargetMajorVersion' => ['description' => 'The major engine version of the instance to which you want to upgrade.', 'type' => 'string', 'example' => '12.0', 'title' => ''],
'EffectiveTime' => ['description' => 'The expiration time of the precheck report.'."\n"
."\n"
.'The time follows the UNIX time format. The time is displayed in UTC. Unit: milliseconds.', 'type' => 'string', 'example' => '1635748703000', 'title' => ''],
'SourceMajorVersion' => ['description' => 'The original major engine version of the instance.', 'type' => 'string', 'example' => '11.0', 'title' => ''],
'Result' => ['description' => 'The result of the major version upgrade precheck.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- Success: The precheck is successful.'."\n"
."\n"
.'- Fail: The precheck fails.'."\n"
."\n"
.'- Warning: The precheck is successful but a warning is reported. You can view the precheck report to determine whether to upgrade the major engine version.'."\n"
."\n"
.'> If the value of this parameter is **Fail**, you must check the value of the **Detail** parameter, fix the reported issues, and then try again. For more information about common issues and solutions, see [Understand the major version upgrade check report for an RDS for PostgreSQL instance](~~218391~~).', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'TaskId' => ['description' => 'The ID of the major version upgrade precheck task.', 'type' => 'integer', 'format' => 'int32', 'example' => '416980000', 'title' => ''],
'Detail' => ['description' => 'The content of the major version upgrade precheck report.', 'type' => 'string', 'example' => '[user_check_report]User check success\\n[pg_upgrade_internal.log]Performing...', 'title' => ''],
'CheckTime' => ['description' => 'The time when the precheck was performed.'."\n"
."\n"
.'The time follows the UNIX time format. The time is displayed in UTC. Unit: milliseconds.', 'type' => 'string', 'example' => '1635143903000', 'title' => ''],
'RecommendDiskSize' => ['description' => 'The recommended minimum storage capacity that is required for the major engine version upgrade. Unit: GB.'."\n"
."\n"
.'> This parameter is returned only for ApsaraDB RDS for PostgreSQL instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'RecommendLeastMemSize' => ['description' => 'The recommended minimum memory that is required for the major engine version upgrade. Unit: GB.'."\n"
."\n"
.'> This parameter is returned only for ApsaraDB RDS for PostgreSQL instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'RecommendMemSize' => ['description' => 'The recommended memory for the major engine version upgrade. Unit: GB.'."\n"
."\n"
.'If the memory of the instance is greater than or equal to the recommended memory, the upgrade proceeds at maximum speed to minimize the read-only time of the instance.'."\n"
."\n"
.'> This parameter is returned only for ApsaraDB RDS for PostgreSQL instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
'UpgradeMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'DescribeUpgradeMajorVersionPrecheckTask',
'description' => '### Applicable engines'."\n"
."\n"
.'RDS MySQL'."\n"
."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Feature documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before calling this interface, carefully read the feature documentation to ensure you fully understand the prerequisites and potential impacts.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [RDS MySQL major version upgrade check report](~~2794383~~)'."\n"
."\n"
.'- [Upgrade the major version of an RDS PostgreSQL instance](~~203309~~)'."\n"
."\n"
.'- [Understand the RDS PostgreSQL major version upgrade check report](~~218391~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-17T10:19:32.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-11-13T01:16:15.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-10-25T03:45:05.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpgradeMajorVersionPrecheckTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeUpgradeMajorVersionPrecheckTask',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'DescribeUpgradeMajorVersionTasks' => [
'summary' => 'This API is used to query the history of major version upgrade jobs for RDS PostgreSQL instances. ',
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageRecordCount' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Items' => [
'description' => 'The tasks for major engine version upgrades.'."\n",
'type' => 'array',
'items' => [
'description' => 'Details of a major version upgrade job. ',
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SourceMajorVersion' => ['description' => 'The major engine version of the original instance.'."\n", 'type' => 'string', 'example' => '11.0', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'SourceInsName' => ['description' => 'The ID of the original instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1i3kkq7321****', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '342900000', 'title' => ''],
'TargetInsName' => ['description' => 'The ID of the new instance.'."\n", 'type' => 'string', 'example' => 'pgm-bp1c0v6d8092****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'totalLogicRepLatencyMB' => ['description' => 'Logical replication delay size, in MB.'."\n"
."\n"
.'> Applies only to **zero-downtime** major version upgrades.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'totalLogicRepDelayTime' => ['description' => 'Estimated synchronization time for logical replication delay, in seconds. '."\n"
.'> This is used only for **zero-downtime** major version upgrades. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'zeroDownTimeConnectionString' => ['description' => 'Temporary internal endpoint for zero-downtime major version upgrade, in the format `****.pg.rds.aliyuncs.com`. '."\n"
.'> Applies only to **zero-downtime** major version upgrades.', 'type' => 'string', 'example' => '****.pg.rds.aliyuncs.com', 'title' => ''],
'zeroDownTimePort' => ['description' => 'Port of the higher-version instance, which is the same as the source instance port. '."\n"
.'> Applies only to **zero-downtime** major version upgrades.', 'type' => 'integer', 'format' => 'int32', 'example' => '5432', 'title' => ''],
'cutOver' => ['description' => 'Indicates whether a switch is performed.'."\n"
."\n"
.'- **true**: Yes.'."\n"
.'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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}","type":"json"}]',
'title' => 'Query major version upgrade jobs for RDS PostgreSQL instances ',
'description' => '### Applicable Engine '."\n"
.'RDS PostgreSQL ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-17T10:19:32.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-11-13T01:16:14.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-10-27T09:09:24.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-10-25T03:45:05.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpgradeMajorVersionTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeUpgradeMajorVersionTasks',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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-k', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8A68AEA1-AFBD-53F8-9BBB-06555EAE5C0E', 'title' => ''],
'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'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', 'title' => ''],
'CidrBlock' => ['description' => 'The CIDR block of the vSwitch.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX/24', 'title' => ''],
'Description' => ['description' => 'The description of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vSwitchDescription', 'title' => ''],
'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IzNo' => ['description' => 'The ID of the zone to which the vSwitch belongs.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-j', 'title' => ''],
'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', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1pnaz94xc****', 'title' => ''],
'VSwitchName' => ['description' => 'The vSwitch name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'Specified virtual switch is not found in specified VPC.', 'description' => 'No vSwitch is available in the VPC.'],
['errorCode' => 'IncorrecttVpcId', 'errorMessage' => 'The specified parameter VPCId is not valid.', 'description' => 'The value of the VPCId parameter is invalid. Specify a valid value.'],
['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'Specified VPC zone is not supported.', 'description' => 'The VPC cannot be found in the zone. Specify a different VPC and try again.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-07-27T13:45:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-09-08T06:39:54.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2021-09-08T06:39:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVSwitches'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeVSwitches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeVpcs' => [
'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.', 'type' => 'string', 'required' => false, 'default' => 'cn-hangzhou', 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The availability zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-g', 'title' => ''],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => ['description' => 'The cloud product type.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'rds', 'example' => 'rds', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxxtz*****', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The ID of the VPC to query.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1bva4qkmvqt******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8F4596F7-FA71-590E-9E1C-********', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '14', 'title' => ''],
'Vpcs' => [
'description' => 'The details of the VPCs.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '18757856124****', 'title' => ''],
'Bid' => ['description' => 'The business ID.', 'type' => 'string', 'example' => '26888', 'title' => ''],
'CidrBlock' => ['description' => 'The IPv4 CIDR block of the VPC.', 'type' => 'string', 'example' => '172.16.0.0/12', 'title' => ''],
'GmtCreate' => ['description' => 'The time when the VPC was created.', 'type' => 'string', 'example' => '2023-01-01T12:00:00Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the VPC was last modified.', 'type' => 'string', 'example' => '2023-01-01T12:00:00Z', 'title' => ''],
'IsDefault' => ['description' => 'Indicates whether the VPC is the default VPC.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RegionNo' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'Status' => ['description' => 'The status of the VPC.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'VSwitchs' => [
'description' => 'The details of the vSwitches.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'CidrBlock' => ['description' => 'The IPv4 CIDR block of the vSwitch.', 'type' => 'string', 'example' => '172.16.0.0/24', 'title' => ''],
'GmtCreate' => ['description' => 'The time when the vSwitch was created.', 'type' => 'string', 'example' => '2023-01-01T12:00:00Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the vSwitch was last modified.', 'type' => 'string', 'example' => '2023-01-01T12:00:00Z', 'title' => ''],
'IsDefault' => ['description' => 'Indicates whether the vSwitch is the default vSwitch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IzNo' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-a', 'title' => ''],
'Status' => ['description' => 'The status of the vSwitch.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxxxxx', 'title' => ''],
'VSwitchName' => ['description' => 'The name of the vSwitch.', 'type' => 'string', 'example' => 'default-vswitch', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-xxxxxx', 'title' => ''],
'VpcName' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'my-vpc', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Query the virtual private cloud (VPC) list',
'summary' => 'Lists the Virtual Private Clouds (VPCs) in your Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeVpcs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"8F4596F7-FA71-590E-9E1C-********\\",\\n \\"TotalCount\\": 14,\\n \\"Vpcs\\": [\\n {\\n \\"AliUid\\": \\"18757856124****\\",\\n \\"Bid\\": \\"26888\\",\\n \\"CidrBlock\\": \\"172.16.0.0/12\\",\\n \\"GmtCreate\\": \\"2023-01-01T12:00:00Z\\",\\n \\"GmtModified\\": \\"2023-01-01T12:00:00Z\\",\\n \\"IsDefault\\": true,\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchs\\": [\\n {\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"GmtCreate\\": \\"2023-01-01T12:00:00Z\\",\\n \\"GmtModified\\": \\"2023-01-01T12:00:00Z\\",\\n \\"IsDefault\\": true,\\n \\"IzNo\\": \\"cn-hangzhou-a\\",\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-xxxxxx\\",\\n \\"VSwitchName\\": \\"default-vswitch\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-xxxxxx\\",\\n \\"VpcName\\": \\"my-vpc\\"\\n }\\n ]\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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',
'title' => '',
],
'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', 'title' => ''],
'Ips' => ['description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '10.1.X.X,2.3.X.X', 'title' => ''],
'TemplateId' => ['description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '424', 'title' => ''],
'TemplateName' => ['description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'template_123', 'title' => ''],
'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ED169A3E-1657-4104-82AB-24EA8CD0DB75', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterTemplateId', 'errorMessage' => 'The parameter templateId is invalid.', 'description' => 'The templateId parameter is invalid.'],
['errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', 'description' => ''],
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:16:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhitelistTemplate'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeWhitelistTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy*****', 'title' => ''],
],
],
'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',
'title' => '',
],
'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****', 'title' => ''],
'title' => '',
'example' => '',
],
'TemplateId' => ['description' => 'The ID of the whitelist template.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '412', 'title' => ''],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:49:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhitelistTemplateLinkedInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:DescribeWhitelistTemplateLinkedInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', 'description' => ''],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => ''],
['errorCode' => 'OperationDenied.DBInstance', 'errorMessage' => 'The operation is not permitted due to status of the instance.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance is not found.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'MasterInstanceNotExist', 'errorMessage' => 'master instance not exist.', 'description' => 'The primary instance data does not exist.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.Deleted', 'errorMessage' => 'The specified DB instance is deleted.', 'description' => 'The RDS instance has been deleted.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-10-31T06:37:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:03.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DestroyDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:DestroyDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'description' => 'The DestroyDBInstance operation is phased out.'."\n",
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-07-25T01:51:06.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachGadInstanceMember'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:DetachGadInstanceMember',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'GadInstance', 'arn' => 'acs:rds::{#accountId}:gadinstance/{#GadInstanceName}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['description' => 'The ID of the disk that you want to detach.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rcd-f8zh55g5gbk1byjr****', 'title' => ''],
],
[
'name' => 'DeleteWithInstance',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'none', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'InvalidDevice.Malformed', 'errorMessage' => 'The specified device is not valid.', 'description' => ''],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => '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.', 'description' => 'Flexible temporary disk does not support this operation'],
['errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', 'description' => 'Elastic temporary disk does not support this operation'],
['errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', 'description' => 'Elastic temporary disks do not support snapshot recovery or snapshot creation.'],
['errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', 'description' => 'The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'DiskCategory.OperationNotSupported', 'errorMessage' => 'The type of the specified disk does not support creating a snapshot.', 'description' => 'The current disk does not support this operation.'],
['errorCode' => 'IncorrectDiskStatus.CreatingSnapshot', 'errorMessage' => 'A previous snapshot creation is in process.', 'description' => ''],
['errorCode' => 'IncorrectInstanceStatus.NotSupportESSD', 'errorMessage' => 'The operation is not supported in this status, please reboot the instance.', 'description' => ''],
['errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', 'description' => ''],
['errorCode' => 'InvalidOperation.InstanceTypeNotSupport', 'errorMessage' => 'The instance type of the specified instance does not support hot detach disk.', 'description' => ''],
['errorCode' => 'OperationDenied.DiskCreatingSnapshot', 'errorMessage' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', 'description' => ''],
['errorCode' => 'OperationDenied.DiskTypeViolation', 'errorMessage' => 'The specified disk is a system disk and cannot support the operation.', 'description' => 'The specified cloud disk is a system disk and cannot be uninstalled.'],
['errorCode' => 'OperationDenied.IncorrectDiskStatus', 'errorMessage' => 'The current disk status does not support this operation.', 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8E88DED-533F-4B3C-9207-731FBF394CCA\\"\\n}","type":"json"}]',
'title' => 'DetachRCDisk',
'changeSet' => [
['createdAt' => '2025-05-07T03:00:42.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachRCDisk'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:DetachRCDisk',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'name' => 'InsName',
'in' => 'query',
'schema' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp191w771k******', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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******', 'title' => ''],
],
],
'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',
'title' => '',
],
'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',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The response parameters.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '224DB9F7-3100-4899-AB9C-C938BCCB43E7', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.TooMuchItems', 'errorMessage' => 'The number of DB instance Names should be no more than 20.', 'description' => 'The number of instance names passed in at a time cannot be greater than 20.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'WhitelistTemplateRelationToCustinsId.NotFound', 'errorMessage' => 'Whitelist Template relation to CustinsId not found.', 'description' => ''],
['errorCode' => 'InsName.NotFound', 'errorMessage' => 'InsName not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-22T09:16:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-03-15T13:12:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachWhitelistTemplateToInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:DetachWhitelistTemplateToInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'EnableBackupEncryption' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The ID of the RDS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-wz951f7f******', 'title' => ''],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the encryption key.', 'type' => 'string', 'required' => false, 'example' => '564cf6c4-d2ee-495b-b265-5724******', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-wz951f7f******', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FCA65FA6-658A-5C43-96F4-D************', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BackupEncryptionAlreadyEnabled', 'errorMessage' => 'backup encryption already enabled.', 'description' => ''],
['errorCode' => 'BackupGetAkError', 'errorMessage' => 'An error occurred while backing up the access key.', 'description' => 'The AccessKey pair for the backup is incorrect.'],
['errorCode' => 'TagKmsKeyError', 'errorMessage' => 'The KMS key is invalid.', 'description' => 'The key from KMS is incorrect.'],
['errorCode' => 'BackupEncryptCreateKeyError', 'errorMessage' => 'Backup encrypt create service key error', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'BackupEncryptUnsupportRegion', 'errorMessage' => 'backup encrypt unsupport region.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupPolicy.NotFound', 'errorMessage' => 'Backup Policy not exist.', 'description' => ''],
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', 'description' => ''],
['errorCode' => 'BackupAkProvenNotFound', 'errorMessage' => 'backup ak proven not found', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Enable backup encryption',
'summary' => 'Use this API to enable backup encryption.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:EnableBackupEncryption',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-wz951f7f******\\",\\n \\"RequestId\\": \\"FCA65FA6-658A-5C43-96F4-D************\\"\\n}","type":"json"}]',
],
'EvaluateLocalExtendDisk' => [
'summary' => 'Evaluate the available disk space for emergency local disk scale-out and unlock.',
'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', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-wz9s06u4drm******'."\n", 'title' => ''],
],
[
'name' => 'Storage',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The new storage capacity. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-ac****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Available' => ['description' => 'Indicates whether the instance is available. Valid values: true and false.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-wz9s06u4drm******'."\n", 'title' => ''],
'DBInstanceTransType' => ['description' => 'The data transfer type supported by the instance.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'LocalUpgradeDiskLimit' => ['description' => 'The maximum value of the local disk. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A4C4D26F-E5CE-5A28-8C54-46A6FB318223', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUserId.NotSupport', 'errorMessage' => 'The user ID has no permission.', 'description' => ''],
['errorCode' => 'InvalidTransType.NotSupport', 'errorMessage' => 'When forcing local disk expansion, the instance must be in a locked state.', 'description' => 'To force a local disk to expand, the instance must be in the locked state.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'Current DB type does not support this operation.', 'description' => ''],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The host is not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Evaluate local disk extension',
'changeSet' => [
['createdAt' => '2024-04-15T03:29:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvaluateLocalExtendDisk'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:EvaluateLocalExtendDisk',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban****', 'title' => ''],
'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n"
."\n"
.'* **vpc**'."\n"
.'* **public**'."\n", 'type' => 'string', 'example' => 'vpc', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-qingdao-c', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-m5ezban****', 'title' => ''],
'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****', 'title' => ''],
'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****', 'title' => ''],
'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-bp****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-qingdao-c', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Message' => ['description' => 'An internal parameter. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '7430AB1A-6D49-5B6D-B9E5-920250076074', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', 'description' => 'The operation failed. Check the status of the RDS instance.'],
['errorCode' => 'DBTypeNotSupported', 'errorMessage' => 'The database type is not supported.', 'description' => 'The database engine is not supported.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'changeSet' => [
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDBInstanceTopology'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:GetDBInstanceTopology',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'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', 'title' => ''],
'DbInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-t4n3a****', 'title' => ''],
'EndpointName' => ['description' => 'The ID of the dedicated proxy endpoint.'."\n", 'type' => 'string', 'example' => 'bu****', 'title' => ''],
'EndpointType' => ['description' => 'The default identifier of the dedicated proxy endpoint. The value is fixed as **RWSplit**.'."\n", 'type' => 'string', 'example' => 'RWSplit', 'title' => ''],
'SslExpiredTime' => ['description' => 'The time at which the certificate expires.'."\n", 'type' => 'string', 'example' => '2021-12-16T08:43:20Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D330E60C-8AAA-4D63-8F64-5B78F4692F98', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'The specified VPC instance ID is invalid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', 'description' => 'This operation is not supported for the database engine of the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified endpoint is not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-01-09T11:20:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T14:44:40.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDbProxyInstanceSsl'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:GetDbProxyInstanceSsl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'GrantAccountPrivilege' => [
'summary' => 'This API is used to grant a specified database account access permissions to one or more databases. ',
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Details of the returned parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '81BC9559-7B22-4B7F-B705-5F56DEECDEA7', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', 'description' => 'Failed to update the account. Check the specified parameters or the parameter policy configuration.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'DbRestoring', 'errorMessage' => 'Database is in restoring state.', 'description' => 'The database is in the restoring state.'],
['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', 'description' => 'Your account does not have the required permissions.'],
['errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccount', 'errorMessage' => 'Current DB instance account does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBNameOrAccountPrivilege', 'errorMessage' => 'Account permissions and database names must correspond.', 'description' => 'The account can have only one permission on the database.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', 'description' => 'The permission type of the current account does not support this operation.'],
['errorCode' => 'OperationDenied.AccountMode', 'errorMessage' => 'The operation is not permitted due to account mode of instance.', 'description' => 'The operation failed. The account mode of the current instance does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Failed to connect to host: connection timed out.', 'description' => 'The connection to the host 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.', 'description' => 'Operation failed: SQL Server account permission operation is abnormal. Please check the following possible causes:-The specified user does not exist. -The user has object dependencies in the specified database, and cannot be rebuilt after the user is deleted. -Insufficient permissions to perform this authorized operation. -SQL Server is currently unavailable or unavailable.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81BC9559-7B22-4B7F-B705-5F56DEECDEA7\\"\\n}","type":"json"}]',
'title' => 'Grant Database Access Permissions to an Account',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB'."\n"
."\n"
.'### Related Function Documentation'."\n"
.'>Before using this API, carefully read the function documentation to fully understand the prerequisites and the impact of using this API before performing any operation.>'."\n"
."\n"
.'- [Modify Account Permissions for RDS MySQL](~~96101~~)'."\n"
.'- [Modify Account Permissions for RDS SQL Server](~~95692~~)'."\n"
.'- [Modify Account Permissions for RDS MariaDB](~~97134~~)'."\n"
.'- [Permission Details for RDS PostgreSQL](~~257684~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-05-07T03:36:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-31T08:25:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-17T07:52:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-14T08:53:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-08T02:33:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-19T08:01:36.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-05T07:59:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:GrantAccountPrivilege',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'translator' => 'machine',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-27T04:15:27.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantOperatorPermission'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:GrantOperatorPermission',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ImportUserBackupFile' => [
'summary' => 'This API is used to import backup data from a self-managed MySQL 5.7 database into RDS.',
'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', 'title' => ''],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => [
'description' => 'Import mode. Valid values:'."\n"
."\n"
.'- oss: Download the backup from OSS and import it.'."\n"
.'- stream: Import the backup over the network.',
'type' => 'string',
'example' => 'oss',
'default' => 'oss',
'enum' => ['oss', 'stream'],
'required' => false,
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['description' => 'The description of the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'BackupTest', 'maxLength' => 256, 'minLength' => 2, 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => 'The instance ID.'."\n", 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'SourceInfo',
'in' => 'query',
'schema' => ['description' => 'A case-sensitive JSON array that provides the source information for a full backup. Example:'."\n"
."\n"
.'```'."\n"
.'{"sourceIp":"172.20.xx.xx","sourcePort":"9999"}'."\n"
.'```'."\n"
."\n"
.'The parameters in the array are described as follows:'."\n"
."\n"
.'- `sourceIp`: Source IP address.'."\n"
."\n"
.'- `sourcePort`: Port on which Netcat listens at the source.'."\n"
."\n"
.'> This applies only to native replication instances and requires the `DBInstanceId` parameter to be passed when invoking the API.', 'type' => 'string', 'required' => false, 'example' => '{"sourceIp":"172.20.xx.xx","sourcePort":"9999"}', 'title' => ''],
],
[
'name' => 'BuildReplication',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically set up replication. Valid values:'."\n"
.'- true: Yes. The `MasterInfo` parameter is required.'."\n"
.'- false: No.'."\n"
."\n"
.'> This applies only to native replication instances and requires the `DBInstanceId` parameter to be passed when invoking the API.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'MasterInfo',
'in' => 'query',
'schema' => ['description' => 'A case-sensitive JSON array containing the Master information for setting up MySQL replication. Example:'."\n"
."\n"
.'```'."\n"
.'{"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}'."\n"
.'```'."\n"
."\n"
.'The parameters in the array are described as follows:'."\n"
.'- `masterIp`: Primary database IP address.'."\n"
.'- `masterPort`: Primary database port.'."\n"
.'- `masterUser`: Replication account for the primary database.'."\n"
.'- `masterPassword`: Password for the replication account of the primary database, which must be Base64-encoded.'."\n"
."\n"
.'> This applies only to native replication instances and requires the `DBInstanceId` parameter to be passed when invoking the API.', 'type' => 'string', 'required' => false, 'example' => '{"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}'."\n", 'title' => ''],
],
],
'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****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A140DD14-DCC9-4548-9C72-52A49A58A310', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOssBackupFile.InvalidFile', 'errorMessage' => 'The specified OSS backup file is invalid.', 'description' => 'The operation failed. The backup file cannot be found in the OSS bucket.'],
['errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', 'description' => ''],
['errorCode' => 'InvalidBackupFile.Format', 'errorMessage' => 'The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid.', 'description' => 'The specified parameter BackupFile(BackupId, RestoreTime, or BackupFile) is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidUserBakset', 'errorMessage' => 'The user backup set to be imported is invalid.', 'description' => 'Imported user backup is invalid'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupId\\": \\"b-n8tpg24c6i0v****\\",\\n \\"RequestId\\": \\"A140DD14-DCC9-4548-9C72-52A49A58A310\\",\\n \\"Status\\": true\\n}","type":"json"}]',
'title' => 'Import User Backup',
'description' => '### Supported Engine'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'### Feature Description'."\n"
.'User backups refer to full backup data from a self-managed MySQL database. You can recover user backups to the cloud.'."\n"
."\n"
.'### Notes'."\n"
.'**To invoke this API, you must meet the following conditions:**'."\n"
.'* You have backed up your self-managed MySQL 5.7 or 8.0 database using XtraBackup, and the backup file name ends with `_qp.xb`. For more information, see [Migrate Full Backup Data from Self-Managed MySQL 5.7 or 8.0 Databases to the Cloud](~~251779~~).'."\n"
.'* You have uploaded the backup files of your self-managed MySQL 5.7 or 8.0 database to an OSS bucket in the corresponding Region. For more information, see [Migrate Full Backup Data from Self-Managed MySQL 5.7 or 8.0 Databases to the Cloud](~~251779~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-16T01:53:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-11-14T15:04:24.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-21T06:07:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-25T01:51:05.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportUserBackupFile'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:ImportUserBackupFile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'ClassGroup' => ['description' => 'The instance family. For more information, see [Overview of instance families](~~57184~~).'."\n", 'type' => 'string', 'example' => 'general-purpose', 'title' => ''],
'Cpu' => ['description' => 'The number of CPU cores that are supported by the instance type. Unit: cores.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''],
'EncryptedMemory' => ['description' => 'The size of the encrypted memory that is supported by the security-enhanced instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '4', 'title' => ''],
'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', 'title' => ''],
'MaxConnections' => ['description' => 'The maximum number of connections that are supported by the instance type. Unit: connections.'."\n", 'type' => 'string', 'example' => '2000', 'title' => ''],
'MaxIOMBPS' => ['description' => 'The maximum I/O bandwidth that is supported by the instance type. Unit: Mbit/s.'."\n", 'type' => 'string', 'example' => '1024Mbps', 'title' => ''],
'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', 'title' => ''],
'MemoryClass' => ['description' => 'The memory size that is supported by the instance type. Unit: GB.'."\n", 'type' => 'string', 'example' => '1GB', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'storageType' => ['description' => 'The storage type of the instance.'."\n", 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CF8D35BF-263D-4F7B-883A-1163B79A9EC6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter SecurityIPList is not valid.', 'description' => ''],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', 'description' => 'The IP address is invalid. Specify a valid IP address.'],
['errorCode' => 'InvalidCommodityCode.Malformed', 'errorMessage' => 'The commodity code is invalid.', 'description' => 'The commodity code is invalid.'],
['errorCode' => 'ArticleNotFound', 'errorMessage' => 'Article not found', 'description' => 'No relevant constraints are found.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'GetCommodity.Failed', 'errorMessage' => 'Get commodity failed.', 'description' => 'Failed to obtain commodity information. The value of the CommodityCode parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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":"","errorExample":""}]',
'title' => 'ListClasses',
'description' => '### Supported database engines'."\n"
."\n"
.'* MySQL'."\n"
.'* PostgreSQL'."\n"
.'* SQL Server'."\n"
.'* MariaDB'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-09-26T15:33:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-09-13T06:30:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-13T06:30:31.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClasses'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'ListImportTasks' => [
'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' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call the `DescribeDBInstances` operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values: **1 to 100**.'."\n"
."\n"
.'Default value: **30**.'."\n"
."\n"
.'> If you specify this parameter, the **PageSize** and **PageNumber** parameters are unavailable.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token for the next page of results. For the first request, leave this parameter empty. For subsequent requests, set this value to the `NextToken` value from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAdDWBF2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC'],
'Items' => [
'description' => 'A list of the data import tasks.',
'type' => 'array',
'items' => [
'description' => 'The details of a data import task.',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '342900000', 'title' => ''],
'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => '362c6c7a-4d20-4eac-898c-1495ceab374c', 'title' => ''],
'CreatedTime' => ['description' => 'The time when the task was created. The time is in UTC and is formatted as YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z', 'title' => ''],
'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Importing', 'title' => ''],
'DbVersion' => ['description' => 'The kernel version.', 'type' => 'string', 'example' => '5.7', 'title' => ''],
'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'import', 'title' => ''],
'TargetInstanceName' => ['description' => 'The destination instance ID.', 'type' => 'string', 'example' => 'rm-bp*****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => 'None', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned on the current page.'."\n"
."\n"
.'>', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'List Data Import Jobs ',
'summary' => 'Queries the data import tasks for native replication.',
'description' => 'This operation queries data import tasks for one or more native replication instances.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'rds:ListImportTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk****', 'title' => ''],
'required' => false,
'example' => 'rm-uf6wjk5xxxxxxx',
'maxItems' => 51,
'title' => '',
],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650B3FD', 'title' => ''],
'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-uf6wjk5****', 'title' => ''],
'ResourceType' => ['description' => 'The resource type. The value `ALIYUN::RDS::INSTANCE` indicates ApsaraDB RDS instances.'."\n", 'type' => 'string', 'example' => 'ALIYUN::RDS::INSTANCE', 'title' => ''],
'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'testkey1', 'title' => ''],
'TagValue' => ['description' => 'The tag value that is associated with the specified tag key.'."\n", 'type' => 'string', 'example' => 'testvalue1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'BothEmpty.TagsAndResources', 'errorMessage' => 'The specified Tags and ResourcesIds are not allow to both empty.', 'description' => 'The operation failed. The tag and the resource ID cannot be left unspecified at the same time.'],
['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of Tags parameter is exceed, Valid : 20', 'description' => ''],
['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The number of ResourceIds parameter is exceed , Valid : 50', 'description' => ''],
['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', 'description' => ''],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRCDeploymentName.NotFound', 'errorMessage' => 'The RDS deployment set cannot be found. Check the values of the request parameters.', 'description' => 'The specified deployment set was not found. Check the correctness of the deployment set.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-12-09T06:53:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-15T09:19:44.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/{#InstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b-kwwvr7v8t7of****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'The tag that is added to the full backup file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1:value1', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'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\\"}', 'title' => ''],
'Comment' => ['description' => 'The description of the full backup file.'."\n", 'type' => 'string', 'example' => 'BackupTest', 'title' => ''],
'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', 'title' => ''],
'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''],
'EngineVersion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '5.7', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'OssBucket' => ['description' => 'The name of the OSS bucket in which the full backup file is stored as an object.'."\n", 'type' => 'string', 'example' => 'BackupTest', 'title' => ''],
'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\\"}', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'Reason' => ['description' => 'The reason why the full backup file failed to be imported.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'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', 'title' => ''],
'Retention' => ['description' => 'The retention period of the full backup file. Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'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', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID of the full backup file.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD67C22F-64F3-4448-A9A8-D1606D242879', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:05.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-08-11T07:11:24.000Z', 'description' => 'Response parameters changed, Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserBackupFiles'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:ListUserBackupFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'This account is managed by the Supabase and cannot be modified directly. Use the RDS Supabase console or API to modify.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:48.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockAccount'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:LockAccount',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-i', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'InvalidParam', 'title' => ''],
'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid Parameter.', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ZoneIdNotSupported', 'errorMessage' => 'The zone ID is not supported.', 'description' => 'The operation failed. The operation is not supported in the region.'],
['errorCode' => 'ConnectionNotFound', 'errorMessage' => 'The connection is not found.', 'description' => 'The operation failed. The connection cannot be found.'],
['errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', 'description' => 'The operation failed. Check the status of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateConnectionToOtherZone'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:MigrateConnectionToOtherZone',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', 'title' => ''],
],
[
'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-bpxxxxxxx1', 'title' => ''],
],
[
'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-bpxxxxxxx2', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneIdForLog',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the logger instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k', 'title' => ''],
],
[
'name' => 'ZoneIdForFollower',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the secondary node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
],
'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' => '2245016', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '498AE8CA-8C81-4A01-AF37-2B902014ED30', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '108246861', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', 'description' => 'A switchover for high availability is in progress. Please wait.'],
['errorCode' => 'InvalidTargetDedicatedHostId.NotFound', 'errorMessage' => 'The target dedicated host ID is invalid.', 'description' => 'The host ID is invalid. Check the host ID and make sure that the host is available.'],
['errorCode' => 'InvalidMasterHostName', 'errorMessage' => 'The specified master host zoneId is different from the master zoneId.', 'description' => 'The zone ID of the host is different from the ID of the primary zone.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidPrimaryCustinsStatus', 'errorMessage' => 'Primary DBInstance status is not Active.', 'description' => 'The operation failed. The operation can be performed only when the primary RDS instance to which the read-only RDS instance is attached is running.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.PrimaryDBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of primary instance.', 'description' => 'The operation failed. The RDS instance is deployed in a dedicated cluster and is not running.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'No host is available for the requested instance.', 'description' => 'The specified zone does not have sufficient resources.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'AllocateResourceFailed', 'errorMessage' => 'Failed to allocate resources. Please check the zone and the host you selected.', 'description' => 'Failed to obtain the requested resources. Check whether the zone and the host can provide sufficient resources for the instance type that you specify.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:MigrateDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'nodeId' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rn-6256r4a87xvv7****', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 7,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', 'description' => 'You must specify the dbNode parameter.'],
['errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The specified DBNodeId is not existed.', 'description' => ''],
['errorCode' => 'SecondaryClassCode.Unsupported', 'errorMessage' => 'At least one secondary node has the same classCode as the primary node.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidNodeId', 'errorMessage' => 'Parameter node id is not valid.', 'description' => ''],
['errorCode' => 'SlaveClassCode.Unsupported', 'errorMessage' => 'Need at least one secondary\'s class_code same as primary\'s.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', 'description' => 'The specified DBInstanceStorage parameter is invalid.'],
['errorCode' => 'UnsupportedOperationDirection.DiskUpgrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.', 'description' => ''],
['errorCode' => 'UnsupportedOperationDirection.DiskDowngrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE', 'description' => ''],
['errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', 'description' => ''],
['errorCode' => 'DBNodeParameter.InvalidCombination', 'errorMessage' => 'DBNode class code combination is not valid.', 'description' => ''],
['errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', 'description' => 'The specification code in the parameter is invalid.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidSaleComponentFault', 'errorMessage' => 'The request not refer to the correct order sale component. please contact customer service.', 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', 'description' => 'Current cluster resources are insufficient. Try again later.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\",\\n \\"DBInstanceId\\": \\"rm-uf64oq9381l03w1qp\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'MigrateDBNodes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:MigrateDBNodes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EF1E53AB-5625-49C7-ADF1-FBD0B6640D19', 'title' => ''],
'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',
'title' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:48.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateSecurityIPMode'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:MigrateSecurityIPMode',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'MigrateToOtherZone' => [
'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 instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID. Generally, you cannot change the VPC when migrating an instance across zones.'."\n"
."\n"
.'- This parameter is required if the instance is in a VPC.'."\n"
."\n"
.'- However, for instances that run SQL Server, you can change the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-****', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The ID of the destination zone. You can call the DescribeRegions operation to query zone IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-b', 'title' => ''],
],
[
'name' => 'EffectiveTime',
'in' => 'query',
'schema' => ['description' => 'Specifies when to perform the migration. Valid values:'."\n"
."\n"
.'- **Immediate**: Performs the migration immediately. This is the default value.'."\n"
."\n"
.'- **MaintainTime**: Performs the migration during the instance\'s maintenance window. For more information, see `ModifyDBInstanceMaintainTime`.'."\n"
."\n"
.'- **ScheduleTime**: Performs the migration at a specified time.'."\n"
."\n"
.'> If you set this parameter to **ScheduleTime**, you must also specify the **SwitchTime** parameter.', 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The VSwitch ID.'."\n"
."\n"
.'- This parameter is required for an instance that resides in a VPC. You can call the `DescribeVSwitches` operation to query existing VSwitches.'."\n"
."\n"
.'- For ApsaraDB RDS for PostgreSQL or SQL Server instances using a secondary zone for migration, you can specify multiple VSwitch IDs. Separate the IDs with commas (,) and ensure they correspond to the zones.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf6adz52c2p****', 'title' => ''],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **Basic**: Basic'."\n"
."\n"
.'- **HighAvailability**: High-availability'."\n"
."\n"
.'- **AlwaysOn**: SQL Server Cluster'."\n"
."\n"
.'- **cluster**: MySQL Cluster'."\n"
."\n"
.'- **Finance**: enterprise edition (triple-node)', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'title' => ''],
],
[
'name' => 'ZoneIdSlave1',
'in' => 'query',
'schema' => ['description' => 'The ID of secondary zone 1.'."\n"
."\n"
.'> Required for all editions except the Basic edition.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', 'title' => ''],
],
[
'name' => 'ZoneIdSlave2',
'in' => 'query',
'schema' => ['description' => 'The ID of secondary zone 2.'."\n"
."\n"
.'> This parameter is available only for instances of the enterprise edition (triple-node).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The scheduled time for the migration. Specify the time in UTC, using the *yyyy-MM-dd*T*HH:mm:ss*Z format.'."\n"
."\n"
.'> This parameter is required only when you set the **EffectiveTime** parameter to **ScheduleTime**.', 'type' => 'string', 'required' => false, 'example' => '2021-12-14T15:15:15Z', 'title' => ''],
],
[
'name' => 'IsModifySpec',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to modify the instance specification during the migration.'."\n"
."\n"
.'- **true**: modifies the specification. If you set this parameter to **true**, you must specify at least one of the **DBInstanceClass** and **DBInstanceStorage** parameters.'."\n"
."\n"
.'- **false**: does not modify the specification. This is the default value.'."\n"
."\n"
.'> This parameter applies only to ApsaraDB RDS for MySQL instances.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The new instance type. You can change the instance type but not the storage type. If you set **IsModifySpec** to **true**, you must specify this parameter and/or **DBInstanceStorage**.'."\n"
."\n"
.'For more information about instance types, see [Primary ApsaraDB RDS for MySQL instance types](~~276975~~).', 'type' => 'string', 'required' => false, 'example' => 'mysql.x4.xlarge.2', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The new storage capacity. If you set the **IsModifySpec** parameter to **true**, you must specify at least one of this parameter and the **DBInstanceClass** parameter.'."\n"
."\n"
.'Unit: GB.'."\n"
.'The available storage capacity varies based on the instance type. For more information, see [Primary ApsaraDB RDS for MySQL instance types](~~276975~~).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the Buffer Pool Extension (BPE) feature for the ESSD cloud disk. Valid values:'."\n"
."\n"
.'- **1**: enables the BPE feature.'."\n"
."\n"
.'- **0**: disables the BPE feature.'."\n"
."\n"
.'> For more information about the BPE feature, see [Buffer Pool Extension (BPE)](~~2527067~~).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The storage type of the instance. Valid values:'."\n"
."\n"
.'- **cloud\\_essd**: ESSD PL1 cloud disk.'."\n"
."\n"
.'- **cloud\\_essd2**: ESSD PL2 cloud disk.'."\n"
."\n"
.'- **cloud\\_essd3**: ESSD PL3 cloud disk.'."\n"
."\n"
.'- **cloud\\_ssd**: SSD cloud disk. Not recommended, as this storage type is no longer available for purchase in some regions.', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'title' => ''],
],
[
'name' => 'CustomExtraInfo',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'OrderId' => ['description' => 'The order ID. This parameter is returned only for MySQL instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '21334157599****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'RenewChange.Exist', 'errorMessage' => 'The Current InstanceId existed renewChange order in RDS.', 'description' => 'A specification change task is in progress. Try again after the task is completed.'],
['errorCode' => 'InvalidInstanceCommodityCode.NotFound', 'errorMessage' => 'Parse commodityCode from lx and instance fail.', 'description' => ''],
['errorCode' => 'InvalidMigrateModifyClassOrStorage', 'errorMessage' => 'Specified parameter DBInstanceClass or Storage is invalid.', 'description' => ''],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidZoneId.NotNull', 'errorMessage' => 'The parameter ZoneId must not be null or auto', 'description' => 'ZoneId must not be null or auto.'],
['errorCode' => 'InvalidZoneId.NotEqual', 'errorMessage' => 'The parameter ZoneId is the same as the previous one', 'description' => 'The two zones are the same.'],
['errorCode' => 'InvalidDispenseMode.Format', 'errorMessage' => 'The specified dispense mode is not valid.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'ZoneId.NotMatchWithCategory', 'errorMessage' => 'The Number of ZoneId specified does not match with category', 'description' => ''],
['errorCode' => 'InvalidDefaultVSwitch.NotFound', 'errorMessage' => 'The specified default virtual switch is not found in specified VPC.', 'description' => ''],
['errorCode' => 'InsufficientResourceCapacityCheck', 'errorMessage' => 'There is insufficient capacity available for the requested instance with precheck.', 'description' => 'The available capacity of the instance to be prechecked is insufficient.'],
['errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read instance running in unsupported states', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', 'description' => 'This operation is not supported for instances that have SSL enabled.'],
['errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', 'description' => 'This operation is not supported for instances that are created from BYOL images.'],
['errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', 'description' => 'This operation is not supported for instances that have disk encryption enabled.'],
['errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', 'description' => 'This operation is not supported for instances that have been joined to an AD domain.'],
['errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', 'description' => 'This operation is not supported for instances that have TDE enabled.'],
['errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', 'description' => 'This operation is not supported for instances that have snapshot backup enabled.'],
['errorCode' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'errorMessage' => 'The instance has read-only instance or is read-only instance, this operation is not supported', 'description' => 'This operation is not supported because this instance has read-only instances or it is a read-only instance.'],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'No available ip in the specified vswitch.', 'description' => 'No available IP address exists in the specified vSwitch.'],
['errorCode' => 'OperationDenied.MasterDBInstanceState', 'errorMessage' => 'The operation is not permitted due to status of master instance.', 'description' => 'The operation failed. The configuration of the read-only instance is being changed. In this case, you cannot perform this operation on the primary instance. Wait until the configuration of the read-only instance is changed and try again.'],
['errorCode' => 'InvalidShareInstance.NotSupport', 'errorMessage' => 'The share dbInstance is not support.', 'description' => 'This operation is not supported for shared instances.'],
['errorCode' => 'InvalidZoneIdSlave1.Missing', 'errorMessage' => 'The parameter ZoneIdSlave1 must be specified.', 'description' => 'You must specify the secondary zone ID.'],
['errorCode' => 'MigrateAlreadyExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', 'description' => 'The RDS instance already contains a VPC migration task.'],
['errorCode' => 'InvalidInstanceKind.NotSupport', 'errorMessage' => 'The instance kind does not support this operation.', 'description' => 'The instance type does not support this operation.'],
['errorCode' => 'MissingCategory', 'errorMessage' => 'The instance is missing a category parameter.', 'description' => ''],
['errorCode' => 'InvalidInstanceNodeType.NotFound', 'errorMessage' => 'The specified NodeType is not found.', 'description' => ''],
['errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'EngineVersion specified cannot be replicate with the source DB Instance.', 'description' => 'Instance cloning is not supported for the database engine version of the current instance.'],
['errorCode' => 'CommodityCodeNotFound', 'errorMessage' => 'CommodityCodeNotFound', 'description' => 'The specified parameter CommodityCode is invalid. Please check again.'],
['errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', 'description' => ''],
['errorCode' => 'SSLNotSupport', 'errorMessage' => 'The CharacterType of instance does not support SSL.', 'description' => 'The character type of the instance does not support SSL.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'UnSupportDbTypeReduceDiskSize', 'errorMessage' => 'The current instance does not support scale-in.', 'description' => 'The current instance does not support scale-in.'],
['errorCode' => 'UnsupportedReduceDiskSize', 'errorMessage' => 'Current Instance not support reduce disk size less than limit size.', 'description' => 'The current instance does not support reducing the disk size to less than the limit size.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', 'description' => '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.', 'description' => 'Xfs instance must be single tenant standard instance.'],
['errorCode' => 'InstanceHasLinkedServerInfo', 'errorMessage' => 'The instance has linked server info, please delete linked server info first.', 'description' => 'The current instance has a linked server. Please delete it before migrating to the Availability Zone.'],
],
403 => [
['errorCode' => 'OperationDenied.OutofUsage', 'errorMessage' => 'The resource is out of usage.', 'description' => 'The available resources in the zone are insufficient. Specify a different zone.'],
['errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', 'description' => 'The value of the EffectiveTime parameter is invalid.'],
['errorCode' => 'InvalidTempInstance.NotSupport', 'errorMessage' => 'The temp db Instance is not support.', 'description' => 'The instance is locked.'],
['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted due to instance being locked.', 'description' => 'The operation failed. The RDS instance is locked. Check whether the RDS instance has expired or its storage capacity is exhausted. If the RDS instance has expired, renew the RDS instance. If the storage capacity is exhausted, expand the storage capacity of the RDS instance.'],
['errorCode' => 'ClassicNetworkType.NotSupport', 'errorMessage' => 'The Classic instance network create is not support.', 'description' => 'The current instance cannot be deployed in the classic network. Change the network type to VPC.'],
['errorCode' => 'InstanceNetworkTypeNotFoundFault', 'errorMessage' => 'The specified DBInstanceNetworkType is not found.', 'description' => 'The network type failed the verification check. The network type cannot be found.'],
['errorCode' => 'ProprietaryCloud.NotSupported', 'errorMessage' => 'The proprietary cloud not supported.', 'description' => ''],
['errorCode' => 'MigrateAlreadyReadWriteSplitExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', 'description' => 'A task of migrating data to the specified VPC already exists.'],
['errorCode' => 'InvalidRegionAvzNotFound', 'errorMessage' => 'Specified user does not find the region and avz.', 'description' => ''],
['errorCode' => 'ZoneIdNotSupported', 'errorMessage' => 'The zone ID is not supported.', 'description' => 'The operation failed. The operation is not supported in the region.'],
['errorCode' => 'InvalidVpcInfo.NotFound', 'errorMessage' => 'Specified VPC info does not exist.', 'description' => 'The specified VPC does not exist.'],
['errorCode' => 'InvalidMultiparamZoneInfoList', 'errorMessage' => 'Zoneinfo list is invaild.', 'description' => ''],
['errorCode' => 'MigrateSlaveNotSupport', 'errorMessage' => 'Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.', 'description' => 'The status of the current instance does not support the migration of only the backup database. Forced migration will reduce the performance of accessing the database. Please perform an HA switch first.'],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InstanceEngineType.NotSupport', 'errorMessage' => 'The instance engine and type does not support operations.', 'description' => 'The RDS MySQL instance engine and type do not support this operation. Check whether the instance kindcode and kernel minor version are too low and upgrade the kernel minor version.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', 'description' => 'The current recovery model does not support.'],
['errorCode' => 'UnSupportNonXfsDiskSizeTooLarge', 'errorMessage' => 'Non xfs disk types do not support upgrading to 60T or above.', 'description' => 'Non-xfs disk types do not support upgrading to 60T or higher.'],
['errorCode' => 'ShrinkCountReachedLimit', 'errorMessage' => 'Current DB shrink count reached the limit.', 'description' => ''],
['errorCode' => 'IncorrectReadDBInstanceDisksize', 'errorMessage' => 'Read instance disk size must be equal or higher than primary instance.', 'description' => 'The disk size of the read-only instance must be equal to or greater than that of the primary instance.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'MigrateToOtherZone',
'summary' => 'Migrates an RDS instance to a different availability zone.',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'- RDS SQL Server'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before calling this API, read the related documentation to fully understand its prerequisites and impact.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Migrate an RDS MySQL instance to another availability zone](~~96053~~)'."\n"
."\n"
.'- [Migrate an RDS PostgreSQL instance to another availability zone](~~96746~~)'."\n"
."\n"
.'- [Migrate an RDS SQL Server instance to another availability zone](~~95658~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-12T13:03:25.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2025-01-10T05:54:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-15T07:38:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-15T06:50:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-17T07:52:40.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-04T11:54:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2023-03-31T07:27:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-01T09:55:19.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-13T01:28:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T03:59:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T05:55:10.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-01-12T14:46:07.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
['createdAt' => '2021-10-26T12:32:47.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-26T12:32:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:MigrateToOtherZone',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ADDNS',
'in' => 'query',
'schema' => ['description' => 'The DNS information about the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''],
],
[
'name' => 'ADServerIpAddress',
'in' => 'query',
'schema' => ['description' => 'The IP address of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX', 'title' => ''],
],
[
'name' => 'ADAccountName',
'in' => 'query',
'schema' => ['description' => 'The account of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_account', 'title' => ''],
],
[
'name' => 'ADPassword',
'in' => 'query',
'schema' => ['description' => 'The password for the account of the AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_password', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EngineVersionNotSupported', 'errorMessage' => 'The current engineVersion does not support AD operation.', 'description' => ''],
['errorCode' => 'InvalidADDNS.NotFound', 'errorMessage' => 'Specified adDNS is null.', 'description' => ''],
['errorCode' => 'InvalidAdServerIpAddress.NotFound', 'errorMessage' => 'Specified adServer IpAddress is null.', 'description' => ''],
['errorCode' => 'InvalidAdAccountName.NotFound', 'errorMessage' => 'Specified adAccountName is null.', 'description' => ''],
['errorCode' => 'InvalidAdPassword.NotFound', 'errorMessage' => 'Specified adPassword is null.', 'description' => ''],
['errorCode' => 'InvalidShareDbInstanceClassNotSupport', 'errorMessage' => 'The current instance classType does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidNodeType.NotSupport', 'errorMessage' => 'The specified nodeType does not support.', 'description' => 'The specified node type is not supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'ClusterTypeNotSupported', 'errorMessage' => 'The current Instance ClusterType does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidAdUserName', 'errorMessage' => 'Invalid user name for ad domain.', 'description' => 'The user name for the ad domain is invalid.'],
['errorCode' => 'InvalidAdIp', 'errorMessage' => 'The ip address of the ad domain is invalid.', 'description' => 'the ip address of the ad domain is invalid.'],
['errorCode' => 'InvalidAdDomain', 'errorMessage' => 'The name of the ad domain is invalid.', 'description' => '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.', 'description' => 'The current instance is not in the domain, and the delete operation is only valid if the current instance is in the domain.'],
['errorCode' => 'InvalidOperation.Add', 'errorMessage' => 'Current instance is already in Domain, if you want join another domain, please remove first.', 'description' => 'the current instance has been joined to an ad domain. if you want to join another ad domain, remove the added ad domain.'],
['errorCode' => 'InvalidAdPassword', 'errorMessage' => 'Invalid password for ad domain.', 'description' => 'The password for the ad domain is invalid.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-02-14T08:05:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T09:20:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyADInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyADInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]',
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5xxxxxxxxxx', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The account username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DatabaseTest', 'title' => ''],
],
[
'name' => 'CheckPolicy',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to apply the password policy'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountCheckPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyAccountCheckPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'testuser', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', 'description' => 'The database description is invalid. Specify a valid description.'],
['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Account is invalid.', 'description' => 'The specified account number is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-09T07:22:58.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:26:48.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyAccountDescription',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyAccountMaskingPrivilege' => [
'summary' => 'Modify the encryption or masking permissions of an account in a specified instance.',
'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' => 'Account name. Multiple accounts are supported and must be separated by commas.', 'type' => 'string', 'required' => true, 'maxLength' => 1000, 'example' => 'user1,user2', 'title' => ''],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => ['description' => 'Permission expiration time in UTC format. (Required only for fullAccess permission.)', 'type' => 'string', 'required' => false, 'example' => '2026-01-22T02:01:20Z', 'title' => ''],
],
[
'name' => 'Privilege',
'in' => 'query',
'schema' => [
'description' => 'Permission type (noneAccess, restrictedAccess, fullAccess)',
'type' => 'string',
'required' => true,
'enum' => ['noneAccess', 'fullAccess', 'restrictedAccess'],
'example' => 'restrictedAccess',
'title' => '',
],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'Database name', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Returned data',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'Returned data',
'type' => 'object',
'additionalProperties' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'rm-t4n8t18o******6d5'."\n", 'title' => ''],
'title' => '',
'example' => '',
],
'Message' => ['description' => 'Return message', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '2144F5CC-10C5-3B72-8C74-E52C********'],
'Success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify Account Masking Permission',
'description' => '## Request Description'."\n"
.'- Before using this API, ensure that you have enabled the column encryption service in DAS Security Center.'."\n"
.'- If you receive the error message ColumnEncryptionErrorCode.NOT_PURCHASED when invoking the API, go to the DAS (Database Autonomy Service) Security Center to purchase and enable the column encryption service before using it again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'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"}]',
],
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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}}', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GroupPolicyNotFound', 'errorMessage' => 'The specified group policy does not exist.', 'description' => 'The specified group policy does not exist.'],
['errorCode' => 'InvalidGroupPolicyValue', 'errorMessage' => 'The value of the group policy is invalid.', 'description' => 'Illegal parameter GroupPolicy'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountSecurityPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyAccountSecurityPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'RegionId' => ['description' => 'The ID of the region for which the event history feature is enabled or disabled.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BAC0952C-0EB3-4DE7-A567-B83269BFE43F', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'RegionNotSupport', 'errorMessage' => 'The region is not supported.', 'description' => 'The operation failed. The operation is not supported in the region.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActionEventPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyActionEventPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:EnableEventLog'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'E9ADB6BE-1598-57FC-B86D-D7F4C69B****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should be later than current time.', 'description' => 'The start time must be later than the current time.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'InvalidTime.Format', 'errorMessage' => 'Specified time is not valid.', 'description' => 'The time format is invalid.'],
['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => ''],
['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => ''],
['errorCode' => 'IncorrectTaskType', 'errorMessage' => 'Current task does not support this operation.', 'description' => ''],
['errorCode' => 'TaskHasStarted', 'errorMessage' => 'Task has started.', 'description' => ''],
['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'The status of certain task does not support this operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidRequest', 'errorMessage' => 'Invalid Request.', 'description' => 'Invalid Request'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidParams.RecordNotFound', 'errorMessage' => 'No records found.', 'description' => 'No records found.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-02-28T09:13:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyActiveOperationTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"E9ADB6BE-1598-57FC-B86D-D7F4C69B****\\"\\n}","type":"json"}]',
],
'ModifyBackupPolicy' => [
'summary' => 'Modifies the backup policy settings of an ApsaraDB RDS instance.',
'methods' => ['post', 'get'],
'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. You can call DescribeDBInstances to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'BackupPolicyMode',
'in' => 'query',
'schema' => ['description' => 'The type of the backup policy. Valid values:'."\n"
."\n"
.'* **DataBackupPolicy**: data backup'."\n"
.'* **LogBackupPolicy**: log backup', 'type' => 'string', 'required' => false, 'example' => 'DataBackupPolicy', 'title' => ''],
],
[
'name' => 'PreferredBackupTime',
'in' => 'query',
'schema' => ['description' => 'The time at which to perform a backup task. Format: HH:mmZ-HH:mmZ (UTC).'."\n"
."\n"
.'> * This parameter is required 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', 'title' => ''],
],
[
'name' => 'PreferredBackupPeriod',
'in' => 'query',
'schema' => ['description' => 'The backup cycle. Specify at least two days. Separate multiple values with commas (,). Valid values:'."\n"
.'* **Monday**'."\n"
.'* **Tuesday**'."\n"
.'* **Wednesday**'."\n"
.'* **Thursday**'."\n"
.'* **Friday**'."\n"
.'* **Saturday**'."\n"
.'* **Sunday**'."\n"
."\n"
.'> * This parameter works together with the **BackupInterval** parameter to determine the backup policy. For example, if this parameter specifies Saturday and Sunday and **BackupInterval** specifies 30 minutes, a backup is performed every 30 minutes on Saturday and Sunday.'."\n"
.'> * This parameter is required when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n"
.'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Monday', 'title' => ''],
],
[
'name' => 'BackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The number of days for which data backups are retained. Valid values: **7 to 730**.'."\n"
."\n"
.'> * This parameter is required when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n"
.'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
[
'name' => 'BackupLog',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable log backup. Valid values:'."\n"
."\n"
.'* **Enable**: enabled.'."\n"
.'* **Disabled**: disabled.'."\n"
."\n"
.'**For SQL Server instances**, log backup is enabled by default and cannot be disabled. However, you can modify the log backup frequency as follows:'."\n"
."\n"
.'- Log backup frequency of **every 5 minutes**: Set BackupLog to Enable and leave LogBackupFrequency empty. For more information, see [5-minute log backup](~~2861729~~). **This configuration is not supported when backup on the secondary instance is preferred (BackupPriority is set to 1). Otherwise, an error is returned.**'."\n"
.'- Log backup frequency of **every 30 minutes**: Leave BackupLog empty and set LogBackupFrequency to LogInterval.'."\n"
.'- Log backup frequency **consistent with data backup**: Leave both BackupLog and LogBackupFrequency empty.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy** and is used to enable or disable log backup.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''],
],
[
'name' => 'LogBackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The number of days for which log backups are retained. Valid values: **7 to 730**. The value cannot be greater than the number of days for which data backups are retained.'."\n"
."\n"
.'> * When log backup is enabled, you can set the retention period of log backup files. This setting is supported only for MySQL and PostgreSQL instances.'."\n"
.'> * This parameter applies when **BackupPolicyMode** is set to **DataBackupPolicy** or **LogBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '7', 'title' => ''],
],
[
'name' => 'EnableBackupLog',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable instance log backup for **MySQL**, **PostgreSQL**, and **MariaDB** instances. Valid values:'."\n"
.'* **True** or **1**: enabled.'."\n"
.'* **False** or **0**: shutdown.'."\n"
."\n"
.'> - Instance log backup for **SQL Server** instances is enabled by default and cannot be shut down. You do not need to configure this parameter for SQL Server instances.'."\n"
.'> - This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy** and is used to enable or shutdown log backup.',
'enumValueTitles' => [],
'type' => 'string',
'required' => false,
'enum' => ['1', '0', 'True', 'False'],
'example' => '1',
'title' => '',
],
],
[
'name' => 'EnablePitrProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable point-in-time recovery for **MySQL** instances. Valid values:'."\n"
.'- **True**: enabled.'."\n"
.'- **False**: disabled.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy** and **BackupLog** is set to **Enable**. For more information, see [Configure a point-in-time recovery policy](~~2666046~~).', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
],
[
'name' => 'LocalLogRetentionHours',
'in' => 'query',
'schema' => ['description' => 'The number of hours for which instance log backups are retained on the **MySQL** instance. Valid values: **0 to 168** (7 × 24). A value of 0 indicates that instance log backups are not retained.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy** and is required in this case.', 'type' => 'string', 'required' => false, 'example' => '18', 'title' => ''],
],
[
'name' => 'LocalLogRetentionSpace',
'in' => 'query',
'schema' => ['description' => 'The maximum usage of the local log storage space for a **MySQL** instance. If the usage exceeds this value, the system starts to clean up binary logs from the earliest one until the usage drops below this threshold. Valid values: **0 to 50**. The default value is not modified.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy** and is required in this case.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'HighSpaceUsageProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to unconditionally clean up binary logs when the disk usage of a **MySQL** instance exceeds 80% or the remaining disk space is less than 5 GB. Valid values: **Enable | Disable**. The default value is not modified.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy** and is required in this case.', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'title' => ''],
],
[
'name' => 'LogBackupFrequency',
'in' => 'query',
'schema' => ['description' => 'The log backup frequency for **SQL Server** instances. Valid values:'."\n"
.'* **LogInterval**: **every 30 minutes**.'."\n"
.'* **Empty** (no value required): **every 5 minutes** or **consistent with data backup**.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'LogInterval', 'title' => ''],
],
[
'name' => 'CompressType',
'in' => 'query',
'schema' => ['description' => 'The backup compression method. Valid values:'."\n"
.'* **0**: not compressed.'."\n"
.'* **1**: zlib compression in tar.gz format.'."\n"
.'* **2**: parallel zlib compression.'."\n"
.'* **4**: quicklz compression in xb.gz format. This method is applicable only to MySQL 5.6 and 5.7 and can be used for [individual database and table restoration](~~103175~~).'."\n"
.'* **8**: quicklz compression in xb.gz format. This method is applicable only to MySQL 8.0. Individual database and table restoration is not supported.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'ArchiveBackupRetentionPeriod',
'in' => 'query',
'schema' => ['description' => 'The number of days for which archived backups are retained. The default value is **0**, which indicates that archived backup is not enabled. Valid values: **30 to 1095**.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '365', 'title' => ''],
],
[
'name' => 'ArchiveBackupKeepPolicy',
'in' => 'query',
'schema' => ['description' => 'The retention cycle for archived backups. The number of backups that can be retained within this cycle is determined by **ArchiveBackupKeepCount**. The default value is **0**. Valid values:'."\n"
.'* **ByMonth**: monthly'."\n"
.'* **ByWeek**: weekly'."\n"
.'* **KeepAll**: all retained'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'ByMonth', 'title' => ''],
],
[
'name' => 'ArchiveBackupKeepCount',
'in' => 'query',
'schema' => ['description' => 'The number of archived backups to retain. The default value is **1**. Valid values:'."\n"
.'* When **ArchiveBackupKeepPolicy** is set to **ByMonth**, valid values are **1 to 31**.'."\n"
.'* When **ArchiveBackupKeepPolicy** is set to **ByWeek**, valid values are **1 to 7**.'."\n"
."\n"
.'> * When **ArchiveBackupKeepPolicy** is set to **KeepAll**, this parameter does not need to be specified.'."\n"
.'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ReleasedKeepPolicy',
'in' => 'query',
'schema' => ['description' => 'The data retention policy for archived backups of deleted **MySQL** instances. Valid values:'."\n"
.'* **None**: not retained.'."\n"
.'* **Lastest**: the last backup is retained.'."\n"
.'* **All**: all backups are retained.'."\n"
."\n"
.'> - This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.'."\n"
.'> - For ApsaraDB RDS for MySQL cloud disk instances purchased on or after February 1, 2024, the default value of ReleasedKeepPolicy is **Lastest**. For instance with Premium Local SSDs, the default value is **None**. For details about this feature, see [Backups of deleted instances](~~2836955~~).', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'LogBackupLocalRetentionNumber',
'in' => 'query',
'schema' => ['description' => 'The number of binary logs to retain on the instance. The default value is **60**. Valid values: **6 to 100**.'."\n"
."\n"
.'> * This parameter takes effect only when **BackupPolicyMode** is set to **LogBackupPolicy**.'."\n"
.'> * For MySQL instances, you can set this parameter to -1, which indicates that no limit is imposed on the number of binary logs retained on the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '', 'example' => '60', 'title' => ''],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable backup within seconds. Valid values:'."\n"
.'* **Flash**: enabled.'."\n"
.'* **Standard**: disabled.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''],
],
[
'name' => 'BackupInterval',
'in' => 'query',
'schema' => ['description' => 'The snapshot backup frequency. Valid values:'."\n"
.'* **15**: every 15 minutes.'."\n"
.'* **30**: every 30 minutes.'."\n"
.'* **60**: every 60 minutes.'."\n"
.'* **120**: every 120 minutes.'."\n"
.'* **180**: every 180 minutes.'."\n"
.'* **240**: every 240 minutes.'."\n"
.'* **360**: every 360 minutes.'."\n"
.'* **480**: every 480 minutes.'."\n"
.'* **720**: every 720 minutes.'."\n"
."\n"
.'> * This parameter works together with the **PreferredBackupPeriod** parameter to determine the backup policy.'."\n"
.'> * MySQL instances must be cloud disk instances that run MySQL 5.7 or 8.0 and belong to the **high-availability series or Cluster Edition**.'."\n"
.'> * PostgreSQL instances must be cloud disk instances.'."\n"
.'> * SQL Server instances must have [**snapshot backup**](~~211143~~) **enabled**.'."\n"
.'> * This parameter is invalid when **Category** is set to **Flash**.'."\n"
.'> * This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''],
],
[
'name' => 'BackupMethod',
'in' => 'query',
'schema' => ['description' => 'The backup method for **SQL Server instances with cloud disks**. Valid values:'."\n"
.'* **Physical** (default): physical backup.'."\n"
.'* **Snapshot**: snapshot backup.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'string', 'required' => false, 'example' => 'Physical', 'title' => ''],
],
[
'name' => 'EnableIncrementDataBackup',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable incremental backup for **SQL Server instances with cloud disks or MySQL instances with local SSDs**. Valid values:'."\n"
.'* **False** (default): disabled.'."\n"
.'* **True**: enabled.'."\n"
."\n"
.'> This parameter takes effect only when **BackupPolicyMode** is set to **DataBackupPolicy**.', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''],
],
[
'name' => 'IncBackupInterval',
'in' => 'query',
'schema' => [
'description' => 'The high-frequency incremental backup frequency for **MySQL instances with local SSDs**. Valid values:'."\n"
.'* **60**: every 60 minutes.'."\n"
.'* **120**: every 120 minutes.'."\n"
.'* **240**: every 240 minutes.'."\n"
.'* **360**: every 360 minutes.'."\n"
.'* **720**: every 720 minutes.'."\n"
."\n"
.'> This parameter takes effect only when **EnableIncrementDataBackup** is set to **True**.',
'type' => 'integer',
'format' => 'int32',
'enum' => ['60', '120', '240', '360', '720'],
'required' => false,
'example' => '120',
'title' => '',
],
],
[
'name' => 'BackupPriority',
'in' => 'query',
'schema' => ['description' => 'The [secondary instance backup](~~95717~~) setting for **SQL Server Cluster Edition** instances. Valid values:'."\n"
.'- **1**: secondary instance preferred.'."\n"
.'- **2**: primary instance forced.'."\n"
.' '."\n"
.'> - This parameter takes effect only when **BackupMethod** is set to **Physical**. If **BackupMethod** is set to **Snapshot**, SQL Server Cluster Edition instances are forced to perform backups on the primary instance.'."\n"
.'> - After **secondary instance preferred** (BackupPriority set to 1) is configured, the **5-minute log backup** policy (BackupLog set to Enable and LogBackupFrequency left empty) is **not supported**. Otherwise, an error is returned. Set the log backup frequency to every 30 minutes or consistent with data backup.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'EnableAdvancedBackupPolicy',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'AdvancedDataPolicies',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StrategyId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'ActionType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'OnlyPreserveOneEachHour' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'RetentionValue' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'BakType' => ['type' => 'string', 'default' => 'F', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'FilterKey' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'FilterValue' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'DestType' => ['type' => 'string', 'default' => 'level1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'FilterType' => ['type' => 'string', 'default' => 'crontab', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'SrcRegion' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'OnlyPreserveOneEachDay' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'SrcType' => ['type' => 'string', 'default' => 'db', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'DestRegion' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'RetentionType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'AdvancedLogPolicies',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StrategyId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'ActionType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'LogRetentionType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'DestType' => ['type' => 'string', 'default' => 'level1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'EnableLogBackup' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'SrcType' => ['type' => 'string', 'default' => 'db', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'SrcRegion' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'LogRetentionValue' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'DestRegion' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'FilterKey' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'FilterValue' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'CompressType' => ['description' => 'The backup compression method. Valid values:'."\n"
.'* **0**: not compressed.'."\n"
.'* **1**: zlib compression.'."\n"
.'* **2**: parallel zlib compression.'."\n"
.'* **4**: quicklz compression with database and table restoration enabled.'."\n"
.'* **8**: MySQL 8.0 quicklz compression without database and table restoration support.', 'type' => 'string', 'example' => '4', 'title' => ''],
'DBInstanceID' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'EnableBackupLog' => ['description' => 'Indicates whether instance log backup is enabled. Valid values:'."\n"
.'* **1**: enabled.'."\n"
.'* **0**: shutdown.'."\n"
."\n\n"
.'> Instance log backup for SQL Server instances is enabled by default and cannot be shut down.', 'type' => 'string', 'example' => '1', 'title' => ''],
'HighSpaceUsageProtection' => ['description' => 'Indicates whether binary logs are unconditionally cleaned up when the disk usage of a **MySQL** instance exceeds 80% or the remaining disk space is less than 5 GB.', 'type' => 'string', 'example' => 'Disable', 'title' => ''],
'LocalLogRetentionHours' => ['description' => 'The number of hours for which instance log backups are retained on the **MySQL** instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''],
'LocalLogRetentionSpace' => ['description' => 'The maximum loop space usage of binary logs for the **MySQL** instance.', 'type' => 'string', 'example' => '30', 'title' => ''],
'LogBackupLocalRetentionNumber' => ['description' => 'The number of binary logs retained on the **MySQL** instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA147739-AEAD-4417-9089-65E9B1D8240D', 'title' => ''],
'EnableIncrementDataBackup' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'IncBackupInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'EnablePitrProtection' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidColdRetention.Format', 'errorMessage' => 'Invalid cold retention format.', 'description' => ''],
['errorCode' => 'InvalidLogBackupFrequency.Malformed', 'errorMessage' => 'Invalid log backup frequency.', 'description' => 'The value of the LogBackupFrequency parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidBackupRetentionPeriod.Malformed', 'errorMessage' => 'The specified backup retention period is invalid.', 'description' => 'The backup cycle is left unspecified. Specify a backup cycle in the range of 1 day to 30 days.'],
['errorCode' => 'BackupPropertyNotFound', 'errorMessage' => 'Backup policy not found', 'description' => 'The operation failed. The backup policy cannot be 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.', 'description' => 'Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode.'],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => '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.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => 'No credit card is available.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => 'The instance status does not support this operation.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidDiskType', 'errorMessage' => 'Current disk type does not support this operation.', 'description' => 'The current disk type does not support this operation'],
['errorCode' => 'InvalidIncrementBackupInterval.Malformed', 'errorMessage' => 'Parameter \'IncBackupInterval\' is invalid.', 'description' => 'The IncBackupInterval parameter value is invalid.'],
['errorCode' => 'InvalidLocalLogRetentionSpace.Malformed', 'errorMessage' => 'Parameter \'LocalLogRetentionSpace\' is invalid.', 'description' => 'Parameter \'LocalLogRetentionSpace\' is invalid.'],
['errorCode' => 'InvalidLocalLogRetentionHours.Malformed', 'errorMessage' => 'Parameter \'LocalLogRetentionHours\' is invalid.', 'description' => 'Illegal LocalLogRetentionHours parameter setting.'],
['errorCode' => 'InvalidLogBackupLocalRetentionNumber.Malformed', 'errorMessage' => 'Parameter \'LogBackupLocalRetentionNumber\' is invalid.', 'description' => 'Parameter \'LogBackupLocalRetentionNumber\' is invalid.'],
['errorCode' => 'InvalidBackupInterval.Unsupported', 'errorMessage' => 'BackupInterval can be configured only when Category is set to Standard. The current instance is set to Flash. Please set Category to Standard.', 'description' => 'The backup in seconds (Category = Flash) is enabled for the current instance. BackupInterval is supported only when the Category value is Standard. Please set the Category value to Standard, then configure the BackupInterval parameter.'],
['errorCode' => 'InvalidPitrSetting', 'errorMessage' => 'Log backup is disabled. Enable PITR requires log backup to be enabled.', 'description' => 'Log backup is disabled. If you enable any-point-in-time recovery, log backup must be enabled.'],
],
403 => [
['errorCode' => 'IncorrectCategory', 'errorMessage' => 'Current Instance type does not support Category.', 'description' => 'The category is not supported for the specified instance type.'],
['errorCode' => 'OperationDenied.SwitchSnapshotToPhysical', 'errorMessage' => 'Only physical backup to snapshot backup is supported.', 'description' => 'The current operation only supports physical backups to snapshot backups.'],
['errorCode' => 'OperationDenied.ModifyBackupSwitchOff', 'errorMessage' => 'The switch is not turned on. It is forbidden to modify the backup mode.', 'description' => 'Cross-region backup is not enabled.'],
['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.', 'description' => 'When the instance is in snapshot backup mode, the log backup frequency must not be Same as Data Backup.'],
['errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['errorCode' => 'OperationDenied.ApiForbidden', 'errorMessage' => 'Operation is not permitted.', 'description' => 'The operation is not supported.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'The proxy instance status is not activated.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
['errorCode' => 'InvalidInsType.Malformed', 'errorMessage' => 'Specified instance type is not valid.', 'description' => 'The instance type is invalid.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","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 \\"EnableIncrementDataBackup\\": false,\\n \\"IncBackupInterval\\": 0,\\n \\"EnablePitrProtection\\": false\\n}","type":"json"}]',
'title' => 'Modify instance backup policy',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB'."\n"
."\n"
.'### Related documentation'."\n"
.'>Before you call this operation, carefully 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~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:04.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-29T07:37:29.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-08-31T13:19:09.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-05-10T06:45:30.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyBackupPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:EnableBackupLog'],
['conditionKey' => 'rds:BackupLog'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-7xv8f2zcia0e4****', 'title' => ''],
],
[
'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' => '262186****', 'title' => ''],
],
[
'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-07-15T12:10:23Z', 'title' => ''],
],
],
'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', 'title' => ''],
'Code' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'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', 'title' => ''],
'Data' => ['description' => 'The details of the returned parameters.'."\n", 'type' => 'string', 'example' => '{expectExpireTime=1752581423000, dbClusterId=rm-7xv8f2zcia0e4****, backupId=262186****}', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidExpectExpireTime.Format', 'errorMessage' => 'The specified param ExpectExpireTime is not valid.', 'description' => 'The specified param ExpectExpireTime is not valid.'],
['errorCode' => 'DBS.ParamIsInValid', 'errorMessage' => '%s.', 'description' => 'Parameter error.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidBackupId.NotFound', 'errorMessage' => 'The BackupId provided does not exist.', 'description' => 'The data backup file cannot be found. Before you clone an RDS instance or create a temporary RDS instance, make sure that you specify an available data backup file.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyBackupSetExpireTime',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'ModifyCollationTimeZone' => [
'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-bp15qi0nd1u27****', 'title' => ''],
],
[
'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' => 'Chinese_PRC_CS_AS', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Collation' => ['description' => 'The character set collation of the instance.'."\n", 'type' => 'string', 'example' => 'Chinese_PRC_CS_AS', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp15qi0nd1u27****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '58D48758-F035-52D3-A4FB-80C73DA3E95C', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '56365****', 'title' => ''],
'Timezone' => ['description' => 'The time zone.'."\n", 'type' => 'string', 'example' => 'China Standard Time', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is already open and can only have one user at a time.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyCollationTimeZone',
'summary' => 'Modifies the character set collation and time zone of system databases on an instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-06T01:57:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-27T04:15:28.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCollationTimeZone'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyCollationTimeZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'ModifyComputeBurstConfig' => [
'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 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.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCziJZNwH****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'pgm-2ze63v2p3o3k****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => 'The time at which the modification takes effect. Valid values:'."\n"
.'- **0**: The modification takes effect immediately.'."\n"
.'- **1**: The modification takes effect during the maintenance window. You can call the **ModifyDBInstanceMaintainTime** operation to modify the maintenance window.'."\n"
.'- **2**: The modification takes effect at a specified point in time.', 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The point in time at which the modification takes effect. Format: `yyyy-MM-ddTHH:mm:ssZ` (UTC).'."\n"
.'> This parameter is required when **SwitchTimeMode** is set to **2**.', 'type' => 'string', 'required' => false, 'example' => '2025-05-06T09:24:00Z', 'title' => ''],
],
[
'name' => 'ScaleMaxCpus',
'in' => 'query',
'schema' => ['description' => 'The maximum number of CPUs for elastic scale-out. The value can be up to twice the initial CPU configuration of the instance.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'ScaleMaxMemory',
'in' => 'query',
'schema' => ['description' => 'The maximum memory for elastic scale-out. The value can be up to twice the initial memory configuration of the instance. Unit: GB. The value is adjusted in increments of 2 GB.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''],
],
[
'name' => 'ScaleMaxRcu',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ScaleMinRcu',
'in' => 'query',
'schema' => ['type' => 'number', 'format' => 'double', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'CpuShrinkThreshold',
'in' => 'query',
'schema' => ['description' => 'The CPU utilization threshold for elastic **scale-in**. Valid values: 30 to 55. Unit: %.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''],
],
[
'name' => 'CpuEnlargeThreshold',
'in' => 'query',
'schema' => ['description' => 'The CPU utilization threshold for elastic **scale-out**. Valid values: 60 to 90. Unit: %.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''],
],
[
'name' => 'MemoryShrinkThreshold',
'in' => 'query',
'schema' => ['description' => 'The memory utilization threshold for elastic **scale-in**. Valid values: 30 to 55. Unit: %.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''],
],
[
'name' => 'MemoryEnlargeThreshold',
'in' => 'query',
'schema' => ['description' => 'The memory utilization threshold for elastic **scale-out**. Valid values: 60 to 90. Unit: %.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''],
],
[
'name' => 'BurstStatus',
'in' => 'query',
'schema' => ['description' => 'Set this parameter to **disabled** to disable the committed Serverless feature.', 'type' => 'string', 'required' => false, 'example' => 'disabled', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. This parameter is not supported.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'CrontabJobId',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. This parameter is not supported.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C816A4BF-A6EC-4722-95F9-2055859CCFD2'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'BurstResourceStillExists', 'errorMessage' => 'The instance does not support to disable compute burst because of having burst resource.', 'description' => 'The instance has bursty resources and does not support shutting down committed serverless.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => 'The instance status does not support this operation.'],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => 'The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.'],
['errorCode' => 'InvalidRcuParam', 'errorMessage' => 'Invalid RCU parameters for database instance.', 'description' => 'Invalid RCU parameters for database instance.'],
['errorCode' => 'CommittedServerlessUsingElasticResource', 'errorMessage' => 'Instance is using elastic resources, can not modify to provision.', 'description' => 'The instance is using elastic resources and cannot be modified to a fixed specification.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => 'The proxy instance status is not activated.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify or disable the committed serverless feature',
'summary' => 'Modifies or disables the committed Serverless feature.',
'description' => '### Applicable engine'."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
.'[Committed Serverless](~~2928780~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:ModifyComputeBurstConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C816A4BF-A6EC-4722-95F9-2055859CCFD2\\"\\n}","type":"json"}]',
],
'ModifyCustinsResource' => [
'summary' => 'This API is used to modify RDS instance resources.',
'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******', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Memory', 'title' => ''],
],
[
'name' => 'IncreaseRatio',
'in' => 'query',
'schema' => ['description' => 'The increase rate in percentage.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'AdjustDeadline',
'in' => 'query',
'schema' => ['description' => 'The deadline for the modification.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-12-31 23:59:06', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6B5A6839-31A7-58D4-9F96-772BFAFD1CB5', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '507******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidCPUZoom.NotSupport', 'errorMessage' => 'The param cpuZoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidCPUShar.NotSupport', 'errorMessage' => 'The param cpuShar not in valid range', 'description' => ''],
['errorCode' => 'InvalidMemoryZoom.NotSupport', 'errorMessage' => 'The param memory zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidIOPSZoom.NotSupport', 'errorMessage' => 'The param iops zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidMaxConnZoom.NotSupport', 'errorMessage' => 'The param MaxConne zoom not in valid range', 'description' => ''],
['errorCode' => 'InvalidResource.Type.NotSupport', 'errorMessage' => 'The param Resource Type not in valid range', 'description' => ''],
['errorCode' => 'InvalidIncreaseRatio.Type.NotSupport', 'errorMessage' => 'Insufficient host resources, please reduce the ratio', 'description' => ''],
['errorCode' => 'InvalidDedicatedHostGroupName', 'errorMessage' => 'The DedicatedHostGroupName is invalid', 'description' => ''],
['errorCode' => 'InvalidInsName', 'errorMessage' => 'The InsName is invalid', 'description' => ''],
['errorCode' => 'InvalidIncreaseValue.NotEnouth', 'errorMessage' => 'Resource is not enough.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ClusterTypeError', 'errorMessage' => 'Custins Cluster Type Error, Support User Cluster', 'description' => ''],
['errorCode' => 'DedicatedHostNameIsNull', 'errorMessage' => 'Dedicated Host Name Is Null!', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'PhysicalCustins.NotFound', 'errorMessage' => 'Physical Custins Not Found!', 'description' => ''],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'Current cluster not found host info!', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B5A6839-31A7-58D4-9F96-772BFAFD1CB5\\",\\n \\"TaskId\\": 0\\n}","type":"json"}]',
'title' => 'Modify Instance Resources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustinsResource'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyCustinsResource',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb', 'title' => ''],
],
[
'name' => 'DBDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the database.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testdb01', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', 'description' => 'The database description is invalid. Specify a valid description.'],
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified DB name does not exist.', 'description' => 'The database name cannot be found. Enter a valid database name.'],
['errorCode' => 'Database.UpdateError', 'errorMessage' => 'Update Db failed, please check input value and instance status.', 'description' => 'Failed to update the database. Check the specified parameters and the instance state.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-24T05:58:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBDescription'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBDescription',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyDBInstance' => [
'summary' => 'Modifies an instance. Currently, only the PostgreSQL engine is supported.',
'path' => '',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => true],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The resource group name.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****'],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically use coupons. Valid values:'."\n"
.'* **true** (default): Automatically uses coupons.'."\n"
.'* **false**: Does not automatically use coupons.'."\n"
."\n"
.'> After a coupon is used, the amount deducted by the coupon is not refunded if you downgrade the instance.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', 'title' => ''],
],
[
'name' => 'EffectiveTime',
'in' => 'query',
'schema' => ['description' => 'The effective period for the new configurations. Valid values:'."\n"
.'> **Changing some configurations may affect the instance**. Read the impact section in the [feature documentation](~~96061~~) before you configure this parameter. Perform the operation during off-peak hours.'."\n"
.'* **Immediate** (default): The new configurations take effect immediately.'."\n"
.'* **MaintainTime**: The new configurations take effect during the [maintenance window](~~610402~~).'."\n"
.'* **ScheduleTime**: The new configurations take effect at a specified time. The time must be at least 12 hours later than the current time. The actual switchover time follows the formula: EffectiveTime = ScheduleTime + SwitchTime. Allocate sufficient time for the switchover.', 'type' => 'string', 'required' => false, 'default' => 'Immediate', 'example' => 'Immediate', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The time at which the parameter modification is executed. The EffectiveTime parameter must be set to ScheduleTime. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).'."\n"
.'> The time must be later than the current time (the time when the call is made).', 'type' => 'string', 'required' => false, 'example' => '2019-10-17T18:50:00Z', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call [DescribeDBInstances](~~2628785~~) to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pgm-bp15i4hn07r******', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The instance type. For more information, see [Instance types](~~26312~~).', 'type' => 'string', 'required' => false, 'example' => 'pg.n4.2c.1m', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The [target storage capacity](~~26312~~), in GB. You can call the [DescribeAvailableClasses](~~610393~~) operation to query the available storage capacity range for the target instance type.'."\n"
."\n"
.'> * You must specify at least one of this parameter and the **DBInstanceClass** parameter.'."\n"
.'> * You can call the [DescribeDBInstanceAttribute](~~610394~~) operation to query the current storage capacity of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '5', 'example' => '500', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The instance storage type. Valid values:'."\n"
."\n"
.'* **general_essd**: premium performance disk (recommended)'."\n"
.'* **cloud_essd**: PL1 ESSD'."\n"
.'* **cloud_essd2**: PL2 ESSD'."\n"
.'* **cloud_essd3**: PL3 ESSD', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'title' => ''],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => ['description' => 'The type of specification change for the instance. Valid values:'."\n"
."\n"
.'- **Up** (default): Upgrades a subscription instance, or upgrades/downgrades a pay-as-you-go instance.'."\n"
.'- **Down**: Downgrades a subscription instance.', 'type' => 'string', 'required' => false, 'default' => 'Auto', 'example' => 'Up', 'title' => ''],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The instance edition. Valid values:'."\n"
."\n"
.'- **Basic**: Basic Edition'."\n"
.'- **HighAvailability**: High-availability Edition'."\n"
.'- **cluster**: Cluster Edition', 'type' => 'string', 'required' => false, 'example' => 'Standard', 'title' => ''],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [I/O performance burst feature for premium performance disks](~~2340501~~). Valid values:'."\n"
."\n"
.'- **true**: Enabled.'."\n"
.'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [Buffer Pool Extension (BPE) feature](~~2527067~~) for premium performance disks. Valid values:'."\n"
."\n"
.'- **1**: enabled'."\n"
.'- **0**: not enabled', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'ColdDataEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [cold data archiving feature](~~2701832~~) for general-purpose cloud disks. Valid values:'."\n"
."\n"
.'- **true**: Enabled.'."\n"
."\n"
.'- **false**: Disabled.'."\n"
."\n"
.'Reserved parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TargetMinorVersion',
'in' => 'query',
'schema' => ['description' => 'The [minor engine version](~~126002~~) of the PostgreSQL instance. If the specification change fails because the current minor engine version is not supported, specify the minor engine version to **upgrade the minor engine version during the specification change**.'."\n"
."\n"
.'Format: `rds_postgres_00_`. Example for version 12 with minor version 20200830: `rds_postgres_1200_20200830`.', 'type' => 'string', 'required' => false, 'example' => 'rds_postgres_1200_20200830', 'title' => ''],
],
[
'name' => 'DBNodes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The node information.',
'type' => 'array',
'items' => [
'description' => 'The node information.',
'type' => 'object',
'properties' => [
'Role' => ['description' => 'The node type. Valid values:'."\n"
.'* **Master**: primary node.'."\n"
.'* **Slave**: secondary node.'."\n"
."\n"
.'> For Cluster Edition instances, you can leave this parameter empty and specify the NodeId parameter to identify the node.', 'type' => 'string', 'required' => false, 'example' => 'Master', 'title' => ''],
'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-e', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1g7uym6ia6yroes6dkm', 'title' => ''],
'NodeId' => ['description' => 'The unique identifier of the node, used to specify a node.'."\n"
.'> This parameter is valid only for Cluster Edition instances.', 'type' => 'string', 'required' => false, 'example' => '28542293', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Parameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The parameters and their values. All parameter values are of the STRING type. You can call the DescribeParameterTemplates operation to query parameter names and values.'."\n"
."\n"
.'> If you specify the **ParameterGroupId** parameter and both ParameterGroupId and Parameters modify the same parameter, the value specified in Parameters takes precedence.',
'type' => 'object',
'required' => false,
'additionalProperties' => ['description' => 'The instance parameter.', 'type' => 'string', 'example' => 'authentication_timeout', 'title' => ''],
'title' => '',
'example' => '',
],
],
[
'name' => 'ParameterGroupId',
'in' => 'query',
'schema' => ['description' => 'The parameter template ID.', 'type' => 'string', 'required' => false, 'example' => 'rpg-dp****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID. You can call [DescribeDBInstances](~~2628785~~) to query the instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '221172852******', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedReduceDiskSize', 'errorMessage' => '%s%s', 'description' => ''],
['errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', 'description' => 'The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs.'],
['errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['errorCode' => 'Postpaid.NotSupport', 'errorMessage' => 'Postpaid not supported.', 'description' => ''],
['errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'System concurrent operate.', 'description' => ''],
['errorCode' => 'NotSupportReduceDiskSize', 'errorMessage' => 'Not support reduce disk size.', 'description' => 'You cannot decrease the disk size.'],
['errorCode' => 'IncorrectStorageType', 'errorMessage' => 'Incorrect storage type.', 'description' => ''],
['errorCode' => 'TargetStorageLessThanBottomLine', 'errorMessage' => 'Target storage less than bottom line', 'description' => ''],
['errorCode' => 'InstanceHasUnpaidOrder', 'errorMessage' => 'The specified Instance has unpaid order.', 'description' => ''],
['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Open volume paid cloud database. Your account balance is less than 100 RMB. Top-up and try again.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => ''],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter "%s" is not valid.', 'description' => ''],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'OperationDenied.OrderUnPaid', 'errorMessage' => 'The operation is not permitted due to the wrong Order status (Unpaid).', 'description' => ''],
['errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The instance cluster does not support this operation.', 'description' => 'The operation is not supported for the RDS instance.'],
['errorCode' => 'InvalidUsedTime', 'errorMessage' => 'The parameter usedTime is invalid.', 'description' => 'The specified usedTime parameter is invalid.'],
['errorCode' => 'CannotChangeStorageType', 'errorMessage' => 'Temp upgrade does not support changing storage type.', 'description' => 'Elastic upgrade cannot change the storage type.'],
['errorCode' => 'TempUpgrade.NotSupport', 'errorMessage' => 'The instance does not support temp upgrade.', 'description' => 'This instance does not support elastic upgrade.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Maxscale not supported', 'description' => 'Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy.'],
['errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', 'description' => 'This operation is not supported for instances that have been joined to an AD domain.'],
['errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', 'description' => 'This operation is not supported for instances that have disk encryption enabled.'],
['errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', 'description' => 'This operation is not supported for instances that are created from BYOL images.'],
['errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', 'description' => 'This operation is not supported for instances that have SSL enabled.'],
['errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', 'description' => 'This operation is not supported for instances that have TDE enabled.'],
['errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', 'description' => 'This operation is not supported for instances that have snapshot backup enabled.'],
['errorCode' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'errorMessage' => 'The instance has read-only instance or is read-only instance, this operation is not supported', 'description' => 'This operation is not supported because this instance has read-only instances or it is a read-only instance.'],
['errorCode' => 'InvalidTargetStorageType', 'errorMessage' => 'Can not change storage type when modify instance class or storage.', 'description' => ''],
['errorCode' => 'InvalidTargetCategory', 'errorMessage' => 'Specified classcode is not matched with current product type.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'BackupReadInstanceModifyNotAllowed', 'errorMessage' => 'Modify Backup Read Instance Is Not Allowed.', 'description' => 'You are not allowed to modify the instance from which the backup comes.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'LX.ARGUMENT.ILLEGAL', 'errorMessage' => '变配,当前实例无有效配置', 'description' => ''],
['errorCode' => 'ORD.S.QUERY.PROD.ERROR', 'errorMessage' => 'An error occurred while querying the ordering information', 'description' => 'An order query error occurred.'],
['errorCode' => 'InvalidParameter.NotSupportDiskTypeModify', 'errorMessage' => 'Serverless not support modify disk type!', 'description' => ''],
['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'One or more of the request parameters provided are not valid.', 'description' => 'One or more of the request parameters provided are not valid, please check the API document'],
['errorCode' => 'DBInstancePayTypeNotSupport', 'errorMessage' => 'Current instance PayType not support this operation or the param PayType not match current instance PayType.', 'description' => 'The billing method of the current instance does not support this operation, or the PayType parameter does not match the current instance.'],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'OperationDenied.DurationLimit', 'errorMessage' => 'The duration between two operations should be greater than specified time.', 'description' => ''],
['errorCode' => 'ChangeEngineVersionNotSupported', 'errorMessage' => 'This operation does not support modifying the engine version.', 'description' => 'You cannot modify the major engine version during this operation.'],
['errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['errorCode' => 'EncryptionInstancesNotSupport', 'errorMessage' => 'Cloud disk encryption instances that use byok do not support modify to multi tenant.', 'description' => 'Cloud disk encryption instances that use custom keys do not support changing configuration to general-purpose specifications.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'CurrentInsHasColdDB', 'errorMessage' => 'The current instance has cold storage db.', 'description' => 'The current instance has cold storage db. '],
['errorCode' => 'CurrentInsHasColdStorage', 'errorMessage' => 'Current instance has cold storage.', 'description' => 'The current instance has cold storage enabled.'],
['errorCode' => 'InsufficientResourceCapacityCheck', 'errorMessage' => 'There is insufficient capacity available for the requested instance with precheck.', 'description' => 'The available capacity of the instance to be prechecked is insufficient.'],
['errorCode' => 'InvalidStorageSize.Direction', 'errorMessage' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', 'description' => 'The storage space does not meet the constraint requirements of the current change direction.'],
['errorCode' => 'InvalidStorageType.Direction', 'errorMessage' => 'The specified parameter StorageType does not meet the updating direction constraint requirements.', 'description' => 'The storage type does not satisfy the change direction constraint.'],
['errorCode' => 'EngineNotSupportShrinkStorage', 'errorMessage' => 'The current engine does not support shrinking storage space.', 'description' => 'The current engine does not support shrinking storage space.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidRCUValue', 'errorMessage' => 'scaleMin and scaleMax range is not valid.', 'description' => 'Invalid scaleMin and scaleMax range.'],
['errorCode' => 'ServiceLinkedRole.NotExist', 'errorMessage' => 'SLR does not exist, you needs to create SLR first.', 'description' => 'The SLR does not exist. You need to create an SLR first.'],
['errorCode' => 'ParamGroupOptionValue.NotSupport', 'errorMessage' => 'Specified option value unsupported.', 'description' => 'The specified option value is not supported.'],
['errorCode' => 'CreateUpgradeOrderBusinessException', 'errorMessage' => 'The parameter is illegal or empty.', 'description' => '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.', 'description' => 'The read-only DB instance storage size must be greater than or equal to the primary DB instance.'],
['errorCode' => 'UnsupportedModifyParam', 'errorMessage' => 'Burst param must be only modified.', 'description' => 'Burst param must be only modified.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', 'description' => 'The request is copy, check your token.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', 'description' => '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.', 'description' => 'We 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, set the parameter allowMajorVersionUpgrade to true.'],
['errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'Specified DB SSLStatus does not support this operation.', 'description' => 'The specified database SSL status is invalid.'],
['errorCode' => 'UpgradeEngineVersionCannotChangeStorage', 'errorMessage' => 'Upgrade engine version can not change storage size.', 'description' => 'Upgrading the engine version cannot also change the storage size.'],
['errorCode' => 'ReadOnlyInsNotSupported', 'errorMessage' => 'Instances containing read-only instances do not allow this operation.', 'description' => 'This operation is not allowed for instances that contain read-only instances..'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'The target specification of the master instance must be no less than the original specification.'],
['errorCode' => 'InvalidPayType.NotSame', 'errorMessage' => 'All primary and read-only instances should have the same payment type.', 'description' => 'The payment type of all primary and read-only instances should be the same.'],
['errorCode' => 'InvalidReadOnlyDBInstanceClass.NotSupport', 'errorMessage' => 'The target read-only db instance class can not lower than the original read-only db instance class.', 'description' => 'the target specifications of the read-only instance must be no less than the original specifications (including cpu and memory).'],
['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.', 'description' => 'The storage size cannot be modified in the current operation. If you need to modify the disk type, use other operations to modify the size of the target disk. The size of the target disk must meet the limit of the target disk type.'],
['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.', 'description' => 'The current storage space of the primary or read-only instance does not meet the storage space constraint DBInstanceStorageType by the target disk type. Please modify the storage space size of the instance separately before implementing the local disk cross-cloud disk operation.'],
['errorCode' => 'ReadonlyDBInstanceClassEmpty', 'errorMessage' => 'The read-only target instance class should not be empty.', 'description' => 'The target specification of the read-only instance must not be empty.'],
['errorCode' => 'ReadonlyDBInstanceClassNotSame', 'errorMessage' => 'All readonly db instances should have the same instance class.', 'description' => 'The current specifications of all read-only instances (including instance types and sizes) should be consistent.'],
['errorCode' => 'StopService.ModifyDBInstanceSpec', 'errorMessage' => 'The service has been discontinued and does not permit resizing operations on instances using the classic network.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot change the configuration of the instance.'],
['errorCode' => 'InvalidParam.DiskSize', 'errorMessage' => '%s.', 'description' => 'The disk capacity selected during configuration change is small.'],
['errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', 'description' => 'The specified order does not exist in RDS.'],
['errorCode' => 'NotFindAvailableVswitch', 'errorMessage' => 'Secondary zone, no available switch found under the current vpc.', 'description' => 'in the current vpc, no vswitch is available in the standby zone of the instance.'],
['errorCode' => 'InvalidStorageType.NotSupport', 'errorMessage' => 'The current storage type does not support this operation.', 'description' => 'The current storage type does not support this operation.'],
['errorCode' => 'IncorrectReadDBInstanceMemSize', 'errorMessage' => 'The instance type of read-only instance is too small.', 'description' => 'The instance type of read-only instance is too small.'],
['errorCode' => 'DBInstanceNotServerless', 'errorMessage' => 'The dbinstance is not serverless.', 'description' => 'The specified instance is a non-serverless instance.'],
['errorCode' => 'UnSupportDbTypeReduceDiskSize', 'errorMessage' => 'The current instance does not support scale-in.', 'description' => '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.', 'description' => 'The classic network address is currently disabled and the instance cannot perform configuration changes.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['errorCode' => 'IncorrectReadDBInstanceDisksize', 'errorMessage' => 'Read instance disk size must be equal or higher than primary instance.', 'description' => 'The disk size of the read-only instance must be equal to or greater than that of the primary instance.'],
['errorCode' => 'BetaServerlessNotSupportThisAction', 'errorMessage' => 'Beta Serverless Not Support This Feature', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => 'The database engine version of the instance is not MySQL 8.0. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => 'The node specifications of the instance are inconsistent. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => 'The number of nodes in the instance is not an odd number greater than or equal to 3. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => 'The instance contains tables that use the X-Engine storage engine. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => 'The instance specification has insufficient memory. MySQL Group Replication is not supported.'],
['errorCode' => 'ARMNotSupport', 'errorMessage' => 'ARM arch does not support this operation.', 'description' => 'This operation is not supported on the ARM architecture.'],
['errorCode' => 'HostTypeNotSupport', 'errorMessage' => 'Host type is inconsistent, please check that the original host type is the same as the target host type.', 'description' => 'The host type before and after the change is inconsistent. Make sure the source host type and the target host type are the same.'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'MaxscaleInstanceNotSupport', 'errorMessage' => 'Instances with maxscale instance do not support this operation.', 'description' => 'This operation is not supported for instances with MaxScale.'],
['errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', 'description' => 'This operation is not supported for instances that have read-only instances.'],
['errorCode' => 'UnSupportReduceDiskSize', 'errorMessage' => 'Current instance type does not support reducing disk space.', 'description' => 'The value for cloud disk size reduction is invalid.'],
['errorCode' => 'CloudboxInstanceNotSupport', 'errorMessage' => 'Cloud-box instance does not support this operation.', 'description' => 'This operation is not supported for instances in cloud boxes.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', 'description' => 'This operation is not supported for read-only instances.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => ''],
['errorCode' => 'ShrinkCountReachedLimit', 'errorMessage' => 'Current DB shrink count reached the limit.', 'description' => 'The database shrink count has reached the limit.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['errorCode' => 'UnSupportNonXfsDiskSizeTooLarge', 'errorMessage' => 'Non xfs disk types do not support upgrading to 60T or above.', 'description' => 'Non-xfs disk types do not support upgrading to 60T or higher.'],
['errorCode' => 'UnsupportedReduceDiskSize.BinlogSpeedTooFast', 'errorMessage' => 'Binlog generate speed is too fast for disk shrink operation.', 'description' => 'Binlog generate speed is too fast for disk shrink operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
],
500 => [
['errorCode' => 'CallLxSdkFailed', 'errorMessage' => 'Error calling the order system, please try again later or contact service personnel.', 'description' => '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.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify an instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:46.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceAutoUpgradeMinorVersion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceAutoUpgradeMinorVersion',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyDBInstanceCLS' => [
'summary' => 'Modifies the column encryption algorithm configuration for a specified instance.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-t4n8t18o******6d5'."\n", 'title' => ''],
],
[
'name' => 'EncryptionStatus',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable column encryption. Valid values:'."\n"
."\n"
.'- `1`: Enabled'."\n"
."\n"
.'- `0`: Disabled', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'EncryptionKey',
'in' => 'query',
'schema' => ['description' => 'The ID of the customer managed key (CMK) from Key Management Service (KMS). This parameter is required when you set `EncryptionKeyMode` to `kms_key`.', 'type' => 'string', 'required' => false, 'example' => '749c1df7-****-****-****-****', 'title' => ''],
],
[
'name' => 'RoleArn',
'in' => 'query',
'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role. For more information, see RAM role overview.'."\n"
.'> This parameter applies only when you set `EncryptionKeyMode` to `kms_key`. If you do not specify this parameter, a default internal value is used.', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole', 'title' => ''],
],
[
'name' => 'EncryptionKeyMode',
'in' => 'query',
'schema' => ['description' => 'The source of the encryption key for column encryption. Valid values:'."\n"
."\n"
.'- `client_key`: a randomly generated key that is managed on the client.'."\n"
."\n"
.'- `kms_key`: a CMK that is managed in KMS.'."\n"
."\n"
.'> After you configure an instance to use a key from KMS, you cannot change the key source to `client_key`.', 'type' => 'string', 'required' => false, 'example' => 'kms_key', 'title' => ''],
],
[
'name' => 'EncryptionAlgorithm',
'in' => 'query',
'schema' => ['description' => 'The encryption algorithm. Valid values:'."\n"
."\n"
.'- AES\\_128\\_CBC'."\n"
."\n"
.'- AES\\_128\\_GCM'."\n"
."\n"
.'- AES\\_128\\_CTR'."\n"
."\n"
.'- AES\\_128\\_ECB'."\n"
."\n"
.'- AES\\_256\\_CBC'."\n"
."\n"
.'- AES\\_256\\_GCM'."\n"
."\n"
.'- AES\\_256\\_CTR'."\n"
."\n"
.'- AES\\_256\\_ECB'."\n"
."\n"
.'- SM4\\_128\\_CBC'."\n"
."\n"
.'- SM4\\_128\\_GCM'."\n"
."\n"
.'- SM4\\_128\\_CTR'."\n"
."\n"
.'- SM4\\_128\\_ECB', 'type' => 'string', 'required' => false, 'example' => 'AES_256_GCM', 'title' => ''],
],
[
'name' => 'WhiteListMode',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the allowlist. If you set this parameter to `true`, only columns in the allowlist are encrypted. If you set this parameter to `false`, all columns are encrypted.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IsRotate',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to rotate the key.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The data returned by the request.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '2144F5CC-10C5-3B72-8C74-E5***********', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'IncorrectDBCLSStatus', 'errorMessage' => 'Specified DB CLS status or CLS mode mode does not support this operation.', 'description' => 'CLS status error.'],
['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.', 'description' => 'The current account of the user does not authorize RDS to access the user\'s KMS service. KMS authorization is required. You can refer to the KMS document Authorizing RDS to Access Key Management Service for authorization.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', 'description' => 'The size of the database exceeds the maximum size that is allowed.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', 'description' => 'The roleArn can not be null.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'this cluster not kms service.', 'description' => ''],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => ''],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Modify Column Encryption Algorithm Configuration',
'description' => '## Request'."\n"
."\n"
.'- Before calling this operation, ensure you have enabled the column encryption service in the DAS Security Center.'."\n"
."\n"
.'- If this operation returns an error message, go to the DAS Security Center to purchase and enable the column encryption service, then retry the operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceCLS',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2144F5CC-10C5-3B72-8C74-E5***********\\"\\n}","type":"json"}]',
],
'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' => 'pgm-2ze****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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' => '2025-05-06T09:24:00Z', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', 'description' => 'The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['errorCode' => 'EncryptionKeyNotSupport', 'errorMessage' => 'The encryption key is not support to generate encryption disk.', 'description' => 'This key does not support creating cloud disk encryption instances.'],
['errorCode' => 'IncorrectDBState', 'errorMessage' => 'The current DB state does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state. For example, the RDS instance is being created or is receiving data from a migration task.'],
['errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read running in unsupport states', 'description' => 'The current instance is in the unsupported read or bak read state.'],
['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', 'description' => 'The permission type of the current account does not support this operation.'],
['errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', 'description' => 'The operation failed. Check the status of the RDS instance.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', 'description' => 'This operation is not supported for read-only instances.'],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'],
['errorCode' => 'TargetMajorVesionNotSupported', 'errorMessage' => 'The specified major version is not supported.', 'description' => 'Target large version not supported'],
['errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'The specified account is not found.', 'description' => 'The account was not found. If you are creating an account or resetting your password, please specify your account.'],
['errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', 'description' => 'The read-only RDS instance is not created, or the values of the request parameters are invalid.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-03-31T08:25:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-26T03:06:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-12T04:36:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-09-24T10:39:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T06:07:46.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'ModifyDBInstanceConnectionString' => [
'summary' => 'This API is used to manage the connection address 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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => 'The port number after the change.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3306', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'TargetDBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the target RDS PostgreSQL instance whose connection address you want to swap with the current instance. '."\n"
."\n"
.'> This parameter is supported only for RDS PostgreSQL instances.', 'type' => 'string', 'required' => false, 'example' => 'pgm-bp1206s14p3o****', 'title' => ''],
],
[
'name' => 'RetainVip',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to retain the virtual IP address (VIP) when swapping connection addresses. '."\n"
."\n"
.'- **true**: Retains the VIP. '."\n"
.'- **false** (default): Does not retain the VIP. '."\n"
."\n"
.'> This parameter is supported only for RDS PostgreSQL instances.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DnsConflict', 'errorMessage' => 'Dns is conflict with other custins.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.Malformed', 'errorMessage' => 'The specified parameter ConnectionStringPrefix is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'The operation is not permitted due to status of instance.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'The specified connection string or network type is not found.', 'description' => ''],
['errorCode' => 'MissingConnectionString', 'errorMessage' => 'The request is missing a ConnectionString parameter.', 'description' => 'You must specify ConnectionString.'],
['errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint exist.', 'description' => 'The prefix of the connection address already exists'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => ''],
['errorCode' => 'InvalidPort.Format', 'errorMessage' => 'Specified Port is not valid.', 'description' => 'The specified port is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'The link address has been used by SSL, modification and deletion are prohibited.', 'description' => '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.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65BDA532-28AF-4122-AA39-B382721EEE64\\"\\n}","type":"json"}]',
'title' => 'Manage the connection address and port of an instance',
'description' => '### Supported Engines'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB'."\n"
."\n"
.'### Related Function Documentation'."\n"
.'>Before using this API, carefully read the Function Documentation to fully understand the prerequisites for using the API and the impact of its use before performing any operation.>'."\n"
."\n"
.'- [Modify the connection address and port for RDS MySQL](~~96163~~)'."\n"
.'- [Modify the connection address and port for RDS PostgreSQL](~~96788~~)'."\n"
.'- [Modify the connection address and port for RDS SQL Server](~~95740~~)'."\n"
.'- [Modify the connection address and port for RDS MariaDB](~~97157~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-03-14T13:10:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-27T11:30:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-09-01T02:53:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T06:56:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-04-25T09:38:44.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-04-25T09:38:44.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceConnectionString',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'rr-uf6wjk5****', 'title' => ''],
],
[
'name' => 'ReadSQLReplicationTime',
'in' => 'query',
'schema' => ['description' => 'The replication latency of the read-only instance. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rr-uf6wjk5****', 'title' => ''],
'ReadSQLReplicationTime' => ['description' => 'The replication latency of the read-only instance. Unit: seconds.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '1715482.0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDelayedReplicationTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceDelayedReplicationTime',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.PayType', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', 'description' => 'The operation failed. The operation is not supported for the billing method of the RDS instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-02-28T14:15:02.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDeletionProtection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceDeletionProtection',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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' => 'testInstance', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceDescription.Format', 'errorMessage' => 'Specified DB instance description is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBDescription.Format', 'errorMessage' => 'Specified DB description is not valid.', 'description' => 'The database description is invalid. Specify a valid description.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
.'- RDS SQL Server'."\n"
.'- RDS MariaDB',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:26:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceDescription',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyDBInstanceEndpoint' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'This parameter is used to ensure the idempotence of the request and prevent duplicate submissions. The parameter value is generated by the client and must be unique across different requests.'."\n"
."\n"
.'The parameter value consists of ASCII characters with a maximum length of 64 characters. Non-ASCII characters are not allowed.', 'type' => 'string', 'required' => false, 'example' => '6000170000591aed949d0f****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. You can call DescribeDBInstances to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-****', 'title' => ''],
],
[
'name' => 'DBInstanceEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The endpoint ID of the instance. You can call DescribeDBInstanceEndpoints to query the endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'ep-****'],
],
[
'name' => 'DBInstanceEndpointDescription',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The custom description of the endpoint.', 'type' => 'string', 'required' => false, 'example' => 'for readonly business'],
],
[
'name' => 'NodeItems',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'description' => 'The information list of endpoint nodes.',
'type' => 'array',
'items' => [
'description' => 'The node details.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID. You can call DescribeDBInstances to query the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'rm-****', 'title' => ''],
'NodeId' => ['description' => 'The node ID.'."\n"
."\n"
.'You can query the node ID by using the following methods:'."\n"
.'- View the node ID in the instance topology diagram at the bottom of the instance details page in the ApsaraDB RDS console.'."\n"
.'- Call DescribeDBInstanceAttribute to query the node ID.', 'type' => 'string', 'required' => false, 'example' => 'rn-xxxx-****', 'title' => ''],
'Weight' => ['description' => 'The current weight value of the node. Read traffic is distributed based on this value.'."\n"
."\n"
.'Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The returned fields.',
'type' => 'object',
'properties' => [
'DBInstanceEndpointId' => ['description' => 'The endpoint ID of the instance.', 'type' => 'string', 'example' => 'ep-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F2911788-25E8-42E5-A3A3-1B38D263F01E', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidNodeItems.JsonFormat', 'errorMessage' => 'NodeItems is not a json string.', 'description' => 'The NodeItems parameter value must be a JSON string.'],
['errorCode' => 'EmptyEndpointNodeConfig', 'errorMessage' => 'Specified endpoint has no nodes, add node to endpoint first.', 'description' => 'No nodes are attached to the endpoint. Attach nodes to the endpoint first.'],
['errorCode' => 'InvalidNodeItems.RONodeIdPrimary', 'errorMessage' => 'ReadOnly endpoint can not contain primary node.', 'description' => 'The read-only endpoint cannot contain the primary instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InvalidWeight.Format', 'errorMessage' => 'The Specified Weight format is not valid.', 'description' => 'The weight range is invalid.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Modify the endpoint weight information of an instance',
'summary' => 'Modifies the endpoint weight information of an ApsaraDB RDS cluster instance.',
'description' => '### Applicable engines'."\n"
.''."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.''."\n"
."\n"
.'RDS MySQL',
'changeSet' => [
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceEndpoint'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DBInstanceEndpointId\\": \\"ep-****\\",\\n \\"DBInstanceName\\": \\"rm-****\\"\\n },\\n \\"RequestId\\": \\"F2911788-25E8-42E5-A3A3-1B38D263F01E\\"\\n}","type":"json"}]',
],
'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****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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' => '', '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-****', 'title' => ''],
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '90496720-2319-42A8-87CD-FCE4DF95EBED', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'InvalidParamCombination', 'errorMessage' => 'VPCId,VSwitchId,PrivateIPAddress can not be modified with ConnectionStringPrefix,Port.', 'description' => 'A combination of the VPCId, VSwitchId, and PrivateIPAddress parameters and another combination of the ConnectionStringPrefix and Port parameters must meet the parameter combination requirements.'],
['errorCode' => 'EmptyEndpointNodeConfig', 'errorMessage' => 'Specified endpoint has no nodes, add node to endpoint first.', 'description' => 'No nodes are attached to the endpoint. Attach nodes to the endpoint first.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api called failed, please check vpc vsw vip', 'description' => ''],
['errorCode' => 'InvalidEngineVersion.NotSupport', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', 'description' => 'The specified VPC ID is invalid.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-04-17T05:25:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-09T12:13:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-23T12:39:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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',
'title' => '',
],
],
[
'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',
'title' => '',
],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk543****', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D4D4BE8A-DD46-440A-BFCD-EE31DA81C9DD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', 'description' => 'The instance has tables without primary keys and does not support MySQL group replication (MGR).'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL'."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'### 相关功能文档'."\n"
.'>使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。>'."\n"
."\n"
.'- [RDS MySQL修改数据复制方式](~~96055~~)'."\n"
.'- [RDS PostgreSQL修改数据复制方式](~~151265~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceHAConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceHAConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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-uf6wjk****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidMaintainTime', 'errorMessage' => 'The MaintainTime parameter is invalid.', 'description' => ''],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-08-23T08:33:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-31T07:45:33.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:26:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceMaintainTime',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'pgm-bp1s1j103lo6****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B55934BB-FFAA-5276-80A8-E0FDB12810B3', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidMetricsConfig', 'errorMessage' => 'The specified metrics config is invalid.', 'description' => 'The specified metric configuration is invalid.'],
['errorCode' => 'InvalidScope', 'errorMessage' => 'The specified scope is invalid', 'description' => 'The specified scope is invalid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMetrics'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceMetrics',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.OwnerAccount', 'errorMessage' => 'The specified parameter OwnerAccount is not valid.', 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceMonitorPeriod', 'errorMessage' => 'Current DB instance does not support this monitor period.', 'description' => 'The specified monitoring period is not supported for the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created and whether the RDS instance has not been deleted.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMonitor'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceMonitor',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkExpireTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceNetworkExpireTime',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6f7l4fg90****', 'title' => ''],
],
[
'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-uf6adz52c2p****', 'title' => ''],
],
[
'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.XX.XX', 'title' => ''],
],
[
'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.XX.XX', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '1025486523574', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified network type already exists.', 'description' => ''],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', 'description' => 'The operation failed. No vSwitch IP addresses are available.'],
['errorCode' => 'OperationDenied.Switch', 'errorMessage' => 'The specified instance must not be switched to VPC.', 'description' => 'The operation failed. The RDS instance cannot be switched to a VPC.'],
['errorCode' => 'OperationDenied.DBInstanceNetType', 'errorMessage' => 'Operation is denied by the network type of current database instance.', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'OperationDenied.DBInstanceStatus', 'errorMessage' => 'Operation is denied by the current database instance status.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'OperationNotSupported', 'errorMessage' => 'This operation is not currently supported.', 'description' => 'This operation is not supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceConnType', 'errorMessage' => 'The current DB instance connection type does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the network connection type of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-03-23T13:47:37.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkType'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceNetworkType',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:InstanceNetworkType'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10078937023****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => ' Your tax information is incomplete. Complete your information before the operation.', 'description' => ''],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => ' No payment method is specified for your account. We recommend that you add a payment method.', 'description' => ''],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => ' Your payment method is incomplete. We recommend that you add a payment method.', 'description' => ''],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. Please contact your Customer Manager or open a ticket.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', 'description' => 'The specified order task already exists.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', 'description' => 'Read-only instances do not support the 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.', 'description' => '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.', 'description' => 'When the classic network is offline, the current instance is of the classic network type and has exceeded the time limit of the post-payment instance. You cannot switch the payment method to post-payment.'],
['errorCode' => 'InvalidParam.PREPAY', 'errorMessage' => 'The prepaid instance purchase limit has been exceeded, and changing the payment method to prepaid is not allowed.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the subscription limit. You are not allowed to switch to the subscription method.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-08-13T13:26:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:02.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstancePayType'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstancePayType',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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*****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceReplicationSwitch'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceReplicationSwitch',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8C06AD-3F37-57A0-ABBF-ABD7824F55CE\\"\\n}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-----', 'title' => ''],
],
[
'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-----', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-----', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-----', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PassWord',
'in' => 'query',
'schema' => ['description' => 'The password of the certificate.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zht123456', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidServerCertOrPrivateKey', 'errorMessage' => 'Specify server certificate or private key is invalid.', 'description' => 'The server certificate type or the private key is invalid.'],
['errorCode' => 'InvalidClientCACert', 'errorMessage' => 'Specify client ca certificate is invalid.', 'description' => 'The client CA certificate is invalid.'],
['errorCode' => 'InvalidClientCrl', 'errorMessage' => 'Specify client certificate revocation list is invalid.', 'description' => 'The client CRL is invalid.'],
['errorCode' => 'InvalidCAType.NotFound', 'errorMessage' => 'Specify ca type is not found.', 'description' => 'The server certificate type is invalid.'],
['errorCode' => 'InvalidACL.NotFound', 'errorMessage' => 'Specify acl is not found.', 'description' => 'The access control type is invalid.'],
['errorCode' => 'InvalidSSLStatus', 'errorMessage' => 'Specify ssl status is invalid.', 'description' => 'The operation failed. The setting of SSL encryption is invalid.'],
['errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'Specified DB SSLStatus does not support this operation.', 'description' => 'The specified database SSL status is invalid.'],
['errorCode' => 'InvalidModifyMode.Format', 'errorMessage' => 'Specified modify mode is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'MinorVersionNotSupport.SSLEnabled', 'errorMessage' => 'Custins minor version does not support current action.', 'description' => '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.', 'description' => 'The operation failed due to permission errors. Configure the client CA certificate and try again.'],
['errorCode' => 'InvalidACL.Permission', 'errorMessage' => 'Client ca certificate is set first if need to set acl.', 'description' => 'The operation failed. Configure the client CA certificate and try again.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-26T10:55:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-27T02:30:05.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-12-20T09:40:35.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSSL'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceSSL',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:SSLEnabled'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"777C4593-8053-427B-99E2-105593277CAB\\"\\n}","errorExample":""},{"type":"xml","example":"777C4593-8053-427B-99E2-105593277CAB","errorExample":""}]',
],
'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******', 'title' => ''],
],
[
'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******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the security group rule.'."\n", 'type' => 'string', 'required' => true, 'example' => 'zht_test', 'title' => ''],
],
],
'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', 'title' => ''],
'Message' => ['description' => 'The information about the status code.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '07F6177E-6DE4-408A-BB4F-0723301340F7'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSecurityGroupRule'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceSecurityGroupRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'ModifyDBInstanceSpec' => [
'summary' => 'Modifies the specifications 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 [DescribeDBInstances](~~610396~~) to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'DBInstanceClass',
'in' => 'query',
'schema' => ['description' => 'The [target instance type](~~26312~~). You can call [DescribeAvailableClasses](~~610393~~) to query the instance types to which the instance can be changed.'."\n"
."\n"
.'> * You must specify at least one of this parameter and **DBInstanceStorage**.'."\n"
.'> * You can call [DescribeDBInstanceAttribute](~~610394~~) to query the current instance type.', 'type' => 'string', 'required' => false, 'example' => 'mysql.n8.large.2c', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The [target storage capacity](~~26312~~). Unit: GB. You can call [DescribeAvailableClasses](~~610393~~) to query the available storage capacity range for the target instance type.'."\n"
."\n"
.'> * You must specify at least one of this parameter and **DBInstanceClass**.'."\n"
.'> * You can call [DescribeDBInstanceAttribute](~~610394~~) to query the current storage capacity of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '5', 'example' => '100', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The current billing method of the instance. Valid values:'."\n"
.'- **Postpaid**: pay-as-you-go.'."\n"
.'- **Prepaid**: subscription.'."\n"
.'- **Serverless** (not supported for MariaDB instances): serverless.'."\n"
."\n"
.'> To change the billing method to Serverless, you **must configure the following parameters**: auto-start and auto-stop (AutoPause), scaling range (MaxCapacity and MinCapacity), and elastic policy (SwitchForce). For more information, see [Overview of MySQL Serverless instances](~~411291~~), [Overview of SQL Server Serverless instances](~~604344~~), and [Overview of PostgreSQL Serverless instances](~~607742~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'EffectiveTime',
'in' => 'query',
'schema' => [
'description' => 'The time when the new configurations take effect. Valid values:'."\n"
.'> **Changing some configurations may affect the instance**. Read the [impact section in the feature documentation](~~96061~~) before you configure this parameter. We recommend that you perform this operation during off-peak hours.'."\n"
.'* **Immediate** (default): The new configurations take effect immediately.'."\n"
.'* **MaintainTime**: The new configurations take effect during the [maintenance window](~~610402~~).'."\n"
.'* **ScheduleTime**: The new configurations take effect at a specified time. The specified time must be at least 12 hours later than the current time. The actual switchover time follows the rule: EffectiveTime = ScheduleTime + SwitchTime.',
'enumValueTitles' => ['ScheduleTime' => 'The specified time must be at least 12 hours later than the current time. The actual switchover time follows the rule: EffectiveTime = ScheduleTime + SwitchTime.'],
'type' => 'string',
'required' => false,
'default' => 'Immediate',
'example' => 'MaintainTime',
'title' => '',
],
],
[
'name' => 'EngineVersion',
'in' => 'query',
'schema' => ['description' => 'The database engine version. Valid values:'."\n"
.''."\n"
.'Regular ApsaraDB RDS instances
'."\n"
."\n"
.'- MySQL: 5.5, 5.6, 5.7, 8.0'."\n"
.'- SQL Server: 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, 2019\\_ent'."\n"
.'- PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0'."\n"
.'- MariaDB: 10.3'."\n"
."\n"
.' '."\n"
."\n"
.''."\n"
.'Serverless ApsaraDB RDS instances (not supported for MariaDB)
'."\n"
."\n"
.'- MySQL: 5.7, 8.0'."\n"
.'- SQL Server: 2016\\_std\\_sl, 2017\\_std\\_sl, 2019\\_std\\_sl'."\n"
.'- PostgreSQL: 14.0, 15.0, 16.0'."\n"
."\n"
.' ', 'type' => 'string', 'required' => false, 'example' => '8.0', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The instance storage type. Valid values:'."\n"
.'* **local_ssd**: Premium Local SSD'."\n"
.'* **cloud_ssd**: standard SSD (not recommended because standard SSDs are no longer available for purchase in some regions)'."\n"
.'* **cloud_essd**: PL1 ESSD cloud disk'."\n"
.'* **cloud_essd2**: PL2 ESSD cloud disk'."\n"
.'* **cloud_essd3**: PL3 ESSD cloud disk'."\n"
.'* **general_essd**: premium performance disk'."\n"
."\n"
.'Note the following when you change the storage type:'."\n"
.'* If you change the instance storage type from ESSD to premium performance disk, other parameters such as instance type and storage capacity must remain the same as the current values.'."\n"
."\n"
.'* For MySQL or MariaDB instances that use standard SSDs, you can set this parameter to `cloud_essd` to [upgrade the storage type to ESSD cloud disk](~~314678~~). To perform the upgrade, you must also specify **DBInstanceClass** and **DBInstanceStorage** with the current values.'."\n"
."\n"
.'* For PostgreSQL instances, you can upgrade from standard SSDs to [ESSDs of any PL level](~~96750~~), but **you cannot downgrade from ESSD cloud disks to standard SSDs**.'."\n"
."\n"
.'For PostgreSQL instances, you can upgrade from standard SSDs to [ESSDs of any PL level](~~96750~~), but **you cannot downgrade from ESSD cloud disks to standard SSDs**.', 'type' => 'string', 'required' => false, 'example' => 'local_ssd', 'title' => ''],
],
[
'name' => 'ReadOnlyDBInstanceClass',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The [target instance type for read-only instances](~~276980~~) when you perform an Upgrade/Downgrade to change a MySQL high availability (HA) instance with Premium Local SSDs to a cloud disk instance.', 'type' => 'string', 'required' => false, 'example' => 'mysqlro.n2.large.1c'],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'description' => 'The type of specification change. Valid values:'."\n"
."\n"
.'- **Up** (default): upgrade for subscription instances, and upgrade or downgrade for pay-as-you-go instances.'."\n"
.'- **Down**: downgrade for subscription instances.'."\n"
.'- **TempUpgrade**: elastic upgrade for subscription SQL Server instances. This value is required for elastic upgrades.'."\n"
.'- **Serverless**: configure this value when you adjust the elastic settings of a serverless instance.'."\n"
."\n"
.'> If you change only the **DBInstanceStorageType** parameter, for example, from standard SSD to ESSD, leave this parameter empty.',
'enumValueTitles' => [],
'type' => 'string',
'required' => false,
'default' => 'Auto',
'enum' => ['Up', 'Down', 'Auto', 'TempUpgrade', 'Serverless'],
'example' => 'Up',
'title' => '',
],
],
[
'name' => 'SourceBiz',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to configure this parameter.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'DedicatedHostGroupId',
'in' => 'query',
'schema' => ['description' => 'The dedicated cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'dhg-7a9****', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The time at which the specification change is performed. **We recommend that you perform specification changes during off-peak hours**.'."\n"
."\n"
.'Format: yyyy-MM-ddTHH:mm:ssZ (UTC).'."\n"
."\n"
.'> - The specified time **must be later than the current time** (the time when the call is initiated). Otherwise, the specification change task fails. After the task fails, wait for the order to be automatically canceled before you initiate the call again.'."\n"
.'> - If you only increase the storage capacity or change the ESSD storage type, the specification change takes effect immediately after submission because it does not affect your workloads. You do not need to configure this parameter.', 'type' => 'string', 'required' => false, 'example' => '2019-07-10T13:15:12Z', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****'],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => 'The duration of the SQL Server [elastic upgrade](~~95665~~). Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''],
],
[
'name' => 'ServerlessConfiguration',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The serverless instance configuration.',
'type' => 'object',
'properties' => [
'AutoPause' => ['description' => 'Specifies whether to enable [intelligent suspension and startup](~~2838448~~) for MySQL Serverless or PostgreSQL Serverless instances. Valid values:'."\n"
.'* **true**: enabled.'."\n"
.'* **false** (default): disabled.'."\n"
."\n"
.'> If no connections are established within 10 minutes, the instance enters the suspended state. When a connection is established, the instance is automatically resumed.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''],
'MaxCapacity' => ['description' => 'The **maximum** value of the automatic scaling range for RCUs of the serverless instance. Valid values:'."\n"
.'- MySQL: **1 to 32**'."\n"
.'- SQL Server: **2 to 16** (only integers)'."\n"
.'- PostgreSQL: **1 to 14**'."\n"
."\n"
.'> This value must be greater than or equal to **MinCapacity**.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '8', 'title' => ''],
'MinCapacity' => ['description' => 'The **minimum** value of the automatic scaling range for RCUs of the serverless instance. Valid values:'."\n"
."\n"
.'- MySQL: **0.5 to 32**'."\n"
.'- SQL Server: **2 to 16** (only integers)'."\n"
.'- PostgreSQL: **0.5 to 14**'."\n"
."\n"
.'> This value must be less than or equal to MaxCapacity.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'title' => ''],
'SwitchForce' => ['description' => 'Specifies whether to enable forced scaling for MySQL Serverless or PostgreSQL Serverless instances. Elastic scaling of instance RCUs usually takes effect immediately, but in some special cases (such as during large transaction execution), scaling cannot be completed immediately. You can enable this parameter to force scaling. Valid values:'."\n"
."\n"
.'- **true**: enabled.'."\n"
.'- **false** (default): disabled.'."\n"
."\n"
.'> After this parameter is enabled, **the service may be unavailable for 30 to 120 seconds during forced scaling**. Use this parameter with caution based on your actual requirements.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => 'The [instance edition](~~53509~~). Valid values:'."\n"
.'> This parameter is required when **EngineVersion** is set to a SQL Server version number.'."\n"
.''."\n"
.'Regular ApsaraDB RDS instances
'."\n"
."\n"
.'- **Basic**: Basic Edition'."\n"
.'- **HighAvailability**: High-availability Edition'."\n"
.'- **AlwaysOn**: SQL Server Cluster Edition'."\n"
.'- **Cluster**: MySQL Cluster Edition'."\n"
.'- **Finance**: Enterprise Edition'."\n"
."\n"
.' '."\n"
."\n"
.''."\n"
.'Serverless ApsaraDB RDS instances (not supported for MariaDB)
'."\n"
."\n"
.'- **serverless_basic**: Serverless Basic Edition (applicable only to MySQL and PostgreSQL)'."\n"
.'- **serverless_standard**: Serverless High-availability Edition (applicable only to MySQL and PostgreSQL)'."\n"
.'- **serverless_ha**: Serverless High-availability Edition (applicable only to SQL Server)'."\n"
."\n"
.' ', 'type' => 'string', 'required' => false, 'example' => 'HighAvailability', 'title' => ''],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [I/O performance burst feature for premium performance disks](~~2340501~~). Valid values:'."\n"
."\n"
.'- **true**: enabled.'."\n"
.'- **false**: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use coupons to offset fees. Valid values:'."\n"
."\n"
.'- **true** (default): use coupons.'."\n"
.'- **false**: do not use coupons.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'TargetMinorVersion',
'in' => 'query',
'schema' => ['description' => 'The [minor engine version](~~126002~~) of the PostgreSQL instance. If the specification change fails because the minor engine version is not supported, specify the minor engine version to **upgrade the minor engine version during the specification change**.'."\n"
."\n"
.'Format: `rds_postgres_00_`. Example for version 12 with minor version 20200830: `rds_postgres_1200_20200830`.', 'type' => 'string', 'required' => false, 'example' => 'rds_postgres_1200_20200830', 'title' => ''],
],
[
'name' => 'IoAccelerationEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [Buffer Pool Extension (BPE) feature](~~2527067~~) for premium performance disks. Valid values:'."\n"
."\n"
.'- **1**: enabled.'."\n"
.'- **0**: disabled.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'ColdDataEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the [cold data archiving feature](~~2701832~~) for premium performance disks. Valid values:'."\n"
."\n"
.'- **true**: enabled.'."\n"
."\n"
.'- **false**: disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'ZoneIdSlave1',
'in' => 'query',
'schema' => ['description' => 'The zone ID of the secondary node. If this value is the same as **ZoneId**, the instance uses single-zone deployment. If this value is different from **ZoneId**, the instance uses multi-zone deployment.'."\n"
.'> This parameter is required only when you perform a major version upgrade for SQL Server instances (AllowMajorVersionUpgrade) and need to specify the secondary zone, or when you switch the secondary zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-c', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The vSwitch ID. The zone of the vSwitch must correspond to the zone ID specified in **ZoneId**.'."\n"
."\n"
.'- The network type **InstanceNetworkType** must be **VPC**.'."\n"
.'- If you specify ZoneSlaveId1 (secondary zone ID), specify two vSwitch IDs separated by a comma (,).'."\n"
.'> This parameter is required only when you perform a major version upgrade for SQL Server instances (AllowMajorVersionUpgrade) and need to specify the vSwitch, or when you switch the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1oxflciovg9l7******', 'title' => ''],
],
[
'name' => 'AllowMajorVersionUpgrade',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a [major engine version upgrade](~~127458~~) for SQL Server instances. Valid values:'."\n"
.'- **true**: upgrade.'."\n"
.'- **false** (default): do not upgrade.'."\n"
."\n"
.'> - When you perform a major version upgrade, you must also pass parameter for other required parameters, including DBInstanceId, EngineVersion, DBInstanceClass, Category, ZoneId, and VSwitchId.'."\n"
.'> - If you want to upgrade to the High-availability Edition or Cluster Edition, you must also pass parameter ZoneIdSlave1.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '72329885****', 'title' => ''],
],
[
'name' => 'OptimizedWrites',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to enable the MySQL [16KB atomic write feature](~~2858761~~). Valid values:'."\n"
."\n"
.'- **optimized**: enabled.'."\n"
.'- **none**: disabled.',
'type' => 'string',
'enum' => ['optimized', 'none'],
'required' => false,
'example' => 'optimized',
'title' => '',
],
],
[
'name' => 'CompressionMode',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the MySQL [storage compression feature](~~2861985~~). Valid values:'."\n"
."\n"
.'- **on**: enabled.'."\n"
.'- **off**: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''],
],
[
'name' => 'AllocateStrategy',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20793850608****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3C5CFDEE-F774-4DED-89A2-1D76EC63C575', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidAllocateStrategy', 'errorMessage' => 'The Specified Allocate Strategy is not valid.', 'description' => 'AllocateStrategy parameter error'],
['errorCode' => 'DbVersionUpgradeNotSatisfied', 'errorMessage' => 'message:%s', 'description' => ''],
['errorCode' => 'UnsupportedReduceDiskSize', 'errorMessage' => '%s%s', 'description' => ''],
['errorCode' => 'CannotDecreaseEssdPerfLevel', 'errorMessage' => 'cannot decrease cloud essd performance level.', 'description' => 'The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs.'],
['errorCode' => 'InvalidEssdStorageSize', 'errorMessage' => 'invalid cloud essd storage size.', 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['errorCode' => 'Postpaid.NotSupport', 'errorMessage' => 'Postpaid not supported.', 'description' => ''],
['errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'System concurrent operate.', 'description' => ''],
['errorCode' => 'NotSupportReduceDiskSize', 'errorMessage' => 'Not support reduce disk size.', 'description' => 'You cannot decrease the disk size.'],
['errorCode' => 'IncorrectStorageType', 'errorMessage' => 'Incorrect storage type.', 'description' => ''],
['errorCode' => 'TargetStorageLessThanBottomLine', 'errorMessage' => 'Target storage less than bottom line', 'description' => ''],
['errorCode' => 'InstanceHasUnpaidOrder', 'errorMessage' => 'The specified Instance has unpaid order.', 'description' => ''],
['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Open volume paid cloud database. Your account balance is less than 100 RMB. Top-up and try again.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => ''],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter "%s" is not valid.', 'description' => ''],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'OperationDenied.OrderUnPaid', 'errorMessage' => 'The operation is not permitted due to the wrong Order status (Unpaid).', 'description' => ''],
['errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The instance cluster does not support this operation.', 'description' => 'The operation is not supported for the RDS instance.'],
['errorCode' => 'InvalidUsedTime', 'errorMessage' => 'The parameter usedTime is invalid.', 'description' => 'The specified usedTime parameter is invalid.'],
['errorCode' => 'CannotChangeStorageType', 'errorMessage' => 'Temp upgrade does not support changing storage type.', 'description' => 'Elastic upgrade cannot change the storage type.'],
['errorCode' => 'TempUpgrade.NotSupport', 'errorMessage' => 'The instance does not support temp upgrade.', 'description' => 'This instance does not support elastic upgrade.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Maxscale not supported', 'description' => 'Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy.'],
['errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', 'description' => 'This operation is not supported for instances that have been joined to an AD domain.'],
['errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', 'description' => 'This operation is not supported for instances that have disk encryption enabled.'],
['errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', 'description' => 'This operation is not supported for instances that are created from BYOL images.'],
['errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', 'description' => 'This operation is not supported for instances that have SSL enabled.'],
['errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', 'description' => 'This operation is not supported for instances that have TDE enabled.'],
['errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', 'description' => 'This operation is not supported for instances that have snapshot backup enabled.'],
['errorCode' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'errorMessage' => 'The instance has read-only instance or is read-only instance, this operation is not supported', 'description' => 'This operation is not supported because this instance has read-only instances or it is a read-only instance.'],
['errorCode' => 'InvalidTargetStorageType', 'errorMessage' => 'Can not change storage type when modify instance class or storage.', 'description' => ''],
['errorCode' => 'InvalidTargetCategory', 'errorMessage' => 'Specified classcode is not matched with current product type.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'BackupReadInstanceModifyNotAllowed', 'errorMessage' => 'Modify Backup Read Instance Is Not Allowed.', 'description' => 'You are not allowed to modify the instance from which the backup comes.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'LX.ARGUMENT.ILLEGAL', 'errorMessage' => '变配,当前实例无有效配置', 'description' => ''],
['errorCode' => 'ORD.S.QUERY.PROD.ERROR', 'errorMessage' => 'An error occurred while querying the ordering information', 'description' => 'An order query error occurred.'],
['errorCode' => 'InvalidParameter.NotSupportDiskTypeModify', 'errorMessage' => 'Serverless not support modify disk type!', 'description' => ''],
['errorCode' => 'InvalidParameter.NotSupportModifyServerlessConfigAndDiskTogether', 'errorMessage' => 'Serverless not support modify serverlessconfig and disk together!', 'description' => ''],
['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'One or more of the request parameters provided are not valid.', 'description' => 'One or more of the request parameters provided are not valid, please check the API document'],
['errorCode' => 'DBInstancePayTypeNotSupport', 'errorMessage' => 'Current instance PayType not support this operation or the param PayType not match current instance PayType.', 'description' => 'The billing method of the current instance does not support this operation, or the PayType parameter does not match the current instance.'],
['errorCode' => 'InvalidDBInstanceClass.Offline', 'errorMessage' => 'The specified instance type is no longer provided. Please specify another instance type.', 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'OperationDenied.DurationLimit', 'errorMessage' => 'The duration between two operations should be greater than specified time.', 'description' => ''],
['errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', 'description' => 'The available balance of the account is insufficient.'],
['errorCode' => 'ChangeEngineVersionNotSupported', 'errorMessage' => 'This operation does not support modifying the engine version.', 'description' => 'You cannot modify the major engine version during this operation.'],
['errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['errorCode' => 'EncryptionInstancesNotSupport', 'errorMessage' => 'Cloud disk encryption instances that use byok do not support modify to multi tenant.', 'description' => 'Cloud disk encryption instances that use custom keys do not support changing configuration to general-purpose specifications.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'CurrentInsHasColdDB', 'errorMessage' => 'The current instance has cold storage db.', 'description' => 'The current instance has cold storage db. '],
['errorCode' => 'CurrentInsHasColdStorage', 'errorMessage' => 'Current instance has cold storage.', 'description' => 'The current instance has cold storage enabled.'],
['errorCode' => 'InsufficientResourceCapacityCheck', 'errorMessage' => 'There is insufficient capacity available for the requested instance with precheck.', 'description' => 'The available capacity of the instance to be prechecked is insufficient.'],
['errorCode' => 'InvalidStorageSize.Direction', 'errorMessage' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', 'description' => 'The storage space does not meet the constraint requirements of the current change direction.'],
['errorCode' => 'InvalidStorageType.Direction', 'errorMessage' => 'The specified parameter StorageType does not meet the updating direction constraint requirements.', 'description' => 'The storage type does not satisfy the change direction constraint.'],
['errorCode' => 'EngineNotSupportShrinkStorage', 'errorMessage' => 'The current engine does not support shrinking storage space.', 'description' => 'The current engine does not support shrinking storage space.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidRCUValue', 'errorMessage' => 'scaleMin and scaleMax range is not valid.', 'description' => 'Invalid scaleMin and scaleMax range.'],
['errorCode' => 'ServiceLinkedRole.NotExist', 'errorMessage' => 'SLR does not exist, you needs to create SLR first.', 'description' => 'The SLR does not exist. You need to create an SLR first.'],
['errorCode' => 'ParamGroupOptionValue.NotSupport', 'errorMessage' => 'Specified option value unsupported.', 'description' => 'The specified option value is not supported.'],
['errorCode' => 'CreateUpgradeOrderBusinessException', 'errorMessage' => 'The parameter is illegal or empty.', 'description' => '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.', 'description' => 'The read-only DB instance storage size must be greater than or equal to the primary DB instance.'],
['errorCode' => 'UnsupportedModifyParam', 'errorMessage' => 'Burst param must be only modified.', 'description' => 'Burst param must be only modified.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidRequestId', 'errorMessage' => 'The request is copy, check your token.', 'description' => 'The request is copy, check your token.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', 'description' => '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.', 'description' => 'We 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, set the parameter allowMajorVersionUpgrade to true.'],
['errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'Specified DB SSLStatus does not support this operation.', 'description' => 'The specified database SSL status is invalid.'],
['errorCode' => 'UpgradeEngineVersionCannotChangeStorage', 'errorMessage' => 'Upgrade engine version can not change storage size.', 'description' => 'Upgrading the engine version cannot also change the storage size.'],
['errorCode' => 'ReadOnlyInsNotSupported', 'errorMessage' => 'Instances containing read-only instances do not allow this operation.', 'description' => 'This operation is not allowed for instances that contain read-only instances..'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => 'No credit card is available.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'The target specification of the master instance must be no less than the original specification.'],
['errorCode' => 'InvalidPayType.NotSame', 'errorMessage' => 'All primary and read-only instances should have the same payment type.', 'description' => 'The payment type of all primary and read-only instances should be the same.'],
['errorCode' => 'InvalidReadOnlyDBInstanceClass.NotSupport', 'errorMessage' => 'The target read-only db instance class can not lower than the original read-only db instance class.', 'description' => 'the target specifications of the read-only instance must be no less than the original specifications (including cpu and memory).'],
['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.', 'description' => 'The storage size cannot be modified in the current operation. If you need to modify the disk type, use other operations to modify the size of the target disk. The size of the target disk must meet the limit of the target disk type.'],
['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.', 'description' => 'The current storage space of the primary or read-only instance does not meet the storage space constraint DBInstanceStorageType by the target disk type. Please modify the storage space size of the instance separately before implementing the local disk cross-cloud disk operation.'],
['errorCode' => 'ReadonlyDBInstanceClassEmpty', 'errorMessage' => 'The read-only target instance class should not be empty.', 'description' => 'The target specification of the read-only instance must not be empty.'],
['errorCode' => 'ReadonlyDBInstanceClassNotSame', 'errorMessage' => 'All readonly db instances should have the same instance class.', 'description' => 'The current specifications of all read-only instances (including instance types and sizes) should be consistent.'],
['errorCode' => 'StopService.ModifyDBInstanceSpec', 'errorMessage' => 'The service has been discontinued and does not permit resizing operations on instances using the classic network.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot change the configuration of the instance.'],
['errorCode' => 'InvalidParam.DiskSize', 'errorMessage' => '%s.', 'description' => 'The disk capacity selected during configuration change is small.'],
['errorCode' => 'InvalidOrder.NotFound', 'errorMessage' => 'Specified order does not exist in RDS.', 'description' => 'The specified order does not exist in RDS.'],
['errorCode' => 'NotFindAvailableVswitch', 'errorMessage' => 'Secondary zone, no available switch found under the current vpc.', 'description' => 'in the current vpc, no vswitch is available in the standby zone of the instance.'],
['errorCode' => 'InvalidStorageType.NotSupport', 'errorMessage' => 'The current storage type does not support this operation.', 'description' => 'The current storage type does not support this operation.'],
['errorCode' => 'IncorrectReadDBInstanceMemSize', 'errorMessage' => 'The instance type of read-only instance is too small.', 'description' => 'The instance type of read-only instance is too small.'],
['errorCode' => 'DBInstanceNotServerless', 'errorMessage' => 'The dbinstance is not serverless.', 'description' => 'The specified instance is a non-serverless instance.'],
['errorCode' => 'UnSupportDbTypeReduceDiskSize', 'errorMessage' => 'The current instance does not support scale-in.', 'description' => '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.', 'description' => '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.', 'description' => 'The instance contains the read-only address of the secondary node and cannot be upgraded.'],
['errorCode' => 'InvalidMasterDBInstanceName.NotFound', 'errorMessage' => 'The master instance does not exist under the target account.', 'description' => 'The primary instance is not found under the target account.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['errorCode' => 'IncorrectReadDBInstanceDisksize', 'errorMessage' => 'Read instance disk size must be equal or higher than primary instance.', 'description' => 'The disk size of the read-only instance must be equal to or greater than that of the primary instance.'],
['errorCode' => 'BetaServerlessNotSupportThisAction', 'errorMessage' => 'Beta Serverless Not Support This Feature', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => 'The database engine version of the instance is not MySQL 8.0. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => 'The node specifications of the instance are inconsistent. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => 'The number of nodes in the instance is not an odd number greater than or equal to 3. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => 'The instance contains tables that use the X-Engine storage engine. MySQL Group Replication is not supported.'],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => 'The instance specification has insufficient memory. MySQL Group Replication is not supported.'],
['errorCode' => 'ARMNotSupport', 'errorMessage' => 'ARM arch does not support this operation.', 'description' => 'This operation is not supported on the ARM architecture.'],
['errorCode' => 'HostTypeNotSupport', 'errorMessage' => 'Host type is inconsistent, please check that the original host type is the same as the target host type.', 'description' => 'The host type before and after the change is inconsistent. Make sure the source host type and the target host type are the same.'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'MaxscaleInstanceNotSupport', 'errorMessage' => 'Instances with maxscale instance do not support this operation.', 'description' => 'This operation is not supported for instances with MaxScale.'],
['errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', 'description' => 'This operation is not supported for instances that have read-only instances.'],
['errorCode' => 'UnSupportReduceDiskSize', 'errorMessage' => 'Current instance type does not support reducing disk space.', 'description' => 'The value for cloud disk size reduction is invalid.'],
['errorCode' => 'CloudboxInstanceNotSupport', 'errorMessage' => 'Cloud-box instance does not support this operation.', 'description' => 'This operation is not supported for instances in cloud boxes.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', 'description' => 'This operation is not supported for read-only instances.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => ''],
['errorCode' => 'ShrinkCountReachedLimit', 'errorMessage' => 'Current DB shrink count reached the limit.', 'description' => 'The database shrink count has reached the limit.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudDiskEncryptionNotSupport', 'errorMessage' => 'The encryption key is not allowed for general-purpose instance.', 'description' => 'Universal instances do not support cloud disk encryption.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['errorCode' => 'UnSupportNonXfsDiskSizeTooLarge', 'errorMessage' => 'Non xfs disk types do not support upgrading to 60T or above.', 'description' => 'Non-xfs disk types do not support upgrading to 60T or higher.'],
['errorCode' => 'OperationDenied.SystemConcurrent', 'errorMessage' => 'Failure caused by Concurrent operations.', 'description' => 'The concurrent operation failed. Try again later.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
],
500 => [
['errorCode' => 'CallLxSdkFailed', 'errorMessage' => 'Error calling the order system, please try again later or contact service personnel.', 'description' => '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.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'Modify an apsaraDB RDS instance',
'description' => '### Supported engines'."\n"
."\n"
.'- ApsaraDB RDS for MySQL'."\n"
.'- ApsaraDB RDS for PostgreSQL'."\n"
.'- ApsaraDB RDS for SQL Server'."\n"
.'- ApsaraDB RDS for MariaDB'."\n"
."\n"
.'### Billing description'."\n"
.'This API operation involves [specification change fees](~~57178~~). Read the relevant documentation before you perform this operation.'."\n"
."\n"
.'### Related documentation'."\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~~)',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-23T05:12:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-07T02:37:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-15T02:06:47.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-24T15:55:38.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-12-03T13:01:03.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-19T13:27:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-13T02:31:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-30T03:25:24.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-24T15:38:25.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-09-19T07:40:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-09T13:00:17.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-09-03T14:38:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-12T07:34:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-11T03:20:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-27T06:09:35.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-06-14T07:31:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-07T02:56:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T06:58:46.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-24T06:10:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-23T09:42:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-16T03:19:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-15T03:46:04.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-07T13:19:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-03-11T12:50:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-28T17:03:42.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-27T12:22:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-04T11:54:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-12-25T13:50:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T09:20:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-10-13T09:00:50.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-29T03:51:42.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-26T05:51:07.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-07-04T15:30:20.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-05T13:16:10.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-09T13:04:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-28T01:56:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-19T09:48:18.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-16T05:30:31.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
['createdAt' => '2022-12-13T07:25:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-12-06T16:15:39.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-09T04:31:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-08-11T09:41:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T03:59:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-19T15:45:04.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSpec'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceSpec',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"rm-uf6wjk5****\\",\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"3C5CFDEE-F774-4DED-89A2-1D76EC63C575\\"\\n}","type":"json"}]',
'translator' => 'machine',
],
'ModifyDBInstanceTDE' => [
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****-****-****-****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Specified TDEStatus has already configed in the This instance.', 'description' => ''],
['errorCode' => 'MissingDBName', 'errorMessage' => 'The request is missing a DBName parameter.', 'description' => ''],
['errorCode' => 'InvalidTDEstatus.Format', 'errorMessage' => 'The Specified TDEStatus is not valid.', 'description' => 'The status of TDE is invalid.'],
['errorCode' => 'Invalid.PrivateKey', 'errorMessage' => 'The requested privateKey parameter is invalid.', 'description' => 'The private key in the request is invalid.'],
['errorCode' => 'Invalid.Certificate', 'errorMessage' => 'The requested certificate parameter is invalid.', 'description' => 'The certificate in the request is invalid.'],
['errorCode' => 'CertOrPrivateKeyOrPasswordNotMatched', 'errorMessage' => 'The public certificate, private key, and password do not match.', 'description' => 'The password of the private key in the certificate failed the verification check.'],
['errorCode' => 'InvalidTDEKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The Kms key has been disabled.'],
['errorCode' => 'InvalidTDEStatus.NotFound', 'errorMessage' => 'The specified TDEStatus does not exist.', 'description' => 'The specified TDE status 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.', 'description' => 'The current account of the user does not authorize RDS to access the user\'s KMS service. KMS authorization is required. You can refer to the KMS document Authorizing RDS to Access Key Management Service for authorization.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'BYOKCertExpired', 'errorMessage' => 'The certificate has exceeded the validity period.', 'description' => 'The certificate has expired.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'DBSizeExceeded', 'errorMessage' => 'Exceeding the allowed DB size of DB instance.', 'description' => 'The size of the database exceeds the maximum size that is allowed.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'ByokRoleArnNotFound', 'errorMessage' => 'The roleArn can not be null.', 'description' => ''],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['errorCode' => 'CrossBackupStrategyNotSupport', 'errorMessage' => 'Cross region backup strategy is not supported.', 'description' => 'Cross region backup strategy is not supported.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'this cluster not kms service.', 'description' => ''],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => ''],
['errorCode' => 'InvalidDBName.NotFound', 'errorMessage' => 'Specified one or more DB name does not exist or DB status does not support.', 'description' => 'The operation failed. The instance name cannot be found.'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyDBInstanceTDE',
'summary' => 'Enables the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS instance and modifies the TDE status for the instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-17T05:47:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-16T02:00:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-15T09:19:44.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-11T03:20:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-16T12:08:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-11-16T01:47:01.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceTDE'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceTDE',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:TDEStatus'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"777C4593-8053-427B-99E2-105593277CAB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 777C4593-8053-427B-99E2-105593277CAB\\n","errorExample":""}]',
],
'ModifyDBInstanceVectorSupportStatus' => [
'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' => 'The instance ID. Call the DescribeDBInstances operation to get this ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-2vc2bn5c5b7g6****', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => 'The status of vector storage. Valid values:'."\n"
."\n"
.'- **ON**: Enabled.'."\n"
."\n"
.'- **OFF**: Disabled.',
'type' => 'string',
'required' => true,
'enum' => ['ON', 'OFF'],
'example' => 'Scheduled',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '16C62438-491B-5C02-9B49-BA924A1372A2', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'PendingActionOverdue', 'errorMessage' => 'the action execution time is already overdue', 'description' => 'The specified execution time has expired.'],
['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when the instance is being migrated across engines.'],
['errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'ParamGroup category is basic, not standard.', 'description' => 'The parameter group is a basic parameter group not a standard parameter group.'],
['errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'StorageEngine.NotSupported', 'errorMessage' => 'Current instance storage engine dose not support this operation.', 'description' => ''],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidInstanceParameter', 'errorMessage' => 'Specified name for the instance parameter is not valid.', 'description' => 'The name specified for the instance parameter is invalid.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidParameters', 'errorMessage' => 'Group Replication limits parameters and does not support modification.', 'description' => 'The group Replication has restrictions on parameters and cannot be modified.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => '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.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'OperationDenied.XengineSwitch', 'errorMessage' => 'Current custins can not turn off xengine param.', 'description' => 'The current instance has a xengine table and cannot switch to another parameter template.'],
['errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Parameter value exceeds limit.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', 'description' => 'This operation is not supported for the database engine of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database status does not support the operation.', 'description' => 'The operation failed. The RDS instance is not running.'],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'],
['errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', 'description' => 'The value of the EffectiveTime parameter is invalid.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', 'description' => 'The instance has tables without primary keys and does not support MySQL group replication (MGR).'],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InvalidMySQLEngineVersionSupportVector', 'errorMessage' => 'Invalid MySQL Engine Version Support Vector.', 'description' => 'This MySQL version does not support the vector feature.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', 'description' => 'This operation is not supported for read-only instances.'],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify the vector storage toggle for an instance',
'summary' => 'Enable or disable vector storage for a MySQL instance.',
'description' => '### Supported engine'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before using this API, read the feature documentation to fully understand its prerequisites and consequences.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [RDS MySQL vector storage](~~2998661~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBInstanceVectorSupportStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16C62438-491B-5C02-9B49-BA924A1372A2\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-bp1k8s41l2o52****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
'nodeId' => [
'description' => 'The node ID.'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'rn-6256r4a87xvv7****',
'title' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 7,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20793850608****', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DBNodeFormatFault', 'errorMessage' => 'The specified parameter DBNode is malformed', 'description' => 'The specified dbNode parameter is invalid.'],
['errorCode' => 'DBNodeParameterRequired', 'errorMessage' => 'The specified parameter DBNode is required.', 'description' => 'You must specify the dbNode parameter.'],
['errorCode' => 'DBNodeIdParameter.NotExists', 'errorMessage' => 'The specified DBNodeId is not existed.', 'description' => ''],
['errorCode' => 'SecondaryClassCode.Unsupported', 'errorMessage' => 'At least one secondary node has the same classCode as the primary node.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidNodeId', 'errorMessage' => 'Parameter node id is not valid.', 'description' => ''],
['errorCode' => 'SlaveClassCode.Unsupported', 'errorMessage' => 'Need at least one secondary\'s class_code same as primary\'s.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', 'description' => 'The specified DBInstanceStorage parameter is invalid.'],
['errorCode' => 'UnsupportedOperationDirection.DiskUpgrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.', 'description' => ''],
['errorCode' => 'UnsupportedOperationDirection.DiskDowngrade', 'errorMessage' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE', 'description' => ''],
['errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['errorCode' => 'InvalidMultiTenant', 'errorMessage' => 'Multi tenants cannot exist in a same instance.', 'description' => ''],
['errorCode' => 'DBNodeParameter.InvalidCombination', 'errorMessage' => 'DBNode class code combination is not valid.', 'description' => ''],
['errorCode' => 'InvalidClassCode', 'errorMessage' => 'The specification code in the parameter is invalid.', 'description' => 'The specification code in the parameter is invalid.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidSaleComponentFault', 'errorMessage' => 'The request not refer to the correct order sale component. please contact customer service.', 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['errorCode' => 'OperationDenied.DBType', 'errorMessage' => 'The operation is not permitted due to type of the database.', 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'Current cluster resources are insufficient. Try again later.', 'description' => 'Current cluster resources are insufficient. Try again later.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-07-12T07:34:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-16T09:45:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-23T05:44:26.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-10-21T02:40:52.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBNode'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBNode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'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' => 'exclusive', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'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' => 'Disabled', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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-hangzhou-c', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MaxscaleAlreadyExist', 'errorMessage' => 'The Maxscale is already existed.', 'description' => 'The specified Maxscale already exists.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Maxscale not supported', 'description' => 'Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy.'],
['errorCode' => 'NetWork.NotFound', 'errorMessage' => 'NetWork.NotFound', 'description' => 'The network is unavailable.'],
['errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Either VPC ID or vSwitch ID is incorrect. Please check again.', 'description' => 'The operation failed. Check the value of the VPCId parameter.'],
['errorCode' => 'MaxscaleInternalError', 'errorMessage' => 'Database proxy status is CLASS_CHANGING.', 'description' => 'The specifications of the database proxy are being changed. Restart the RDS instance later.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'InvalidOptimizationCategory.Format', 'errorMessage' => 'Specified optimization category is not valid.', 'description' => 'The specified OptimizationCategory parameter is invalid.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InvalidTunnelId', 'errorMessage' => 'Specified conn tunnel is not valid.', 'description' => ''],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidDBProxyNodes.General', 'errorMessage' => 'general-purpose proxy does not support more than 2 nodes.', 'description' => 'Generic proxy does not support more than 2 nodes.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneIdAndNodeCounts', 'errorMessage' => 'The number of node count and zone count is mismatch.', 'description' => 'The number of zones or nodes is invalid.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneId', 'errorMessage' => 'The number of zone is request 1 or 2.', 'description' => 'The ZoneId of the DBProxyNodes field can only be one or two zones.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneIdNotUnique', 'errorMessage' => 'ZoneIds is not unique.', 'description' => 'The Availability Zone ID is not unique.'],
['errorCode' => 'MaxscaleServiceLinkedRole.NotFound', 'errorMessage' => 'Service linked role \'AliyunServiceRoleForRDSProxyOnEcs\' not found.', 'description' => 'The database proxy service linked role was not found, please check.'],
['errorCode' => 'MappingInstanceLevel.NotFound', 'errorMessage' => 'Can not find the mapping instance level.', 'description' => 'The mapping instance specification was not found.'],
],
403 => [
['errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', 'description' => 'The specified VPC ID is invalid.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'MaxscaleCreating', 'errorMessage' => 'The relative maxscale instance is being created or deleted.', 'description' => ''],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The relative maxscale instance is not found.', 'description' => 'No associated maxscale instance is found.'],
['errorCode' => 'InvalidVSwitchId.NotFound', 'errorMessage' => 'The specified VSwitch is invalid.', 'description' => ''],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', 'description' => 'The target Availability Zone does not have enough resources.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-02-14T08:05:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-15T02:02:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-13T09:38:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2023-12-25T17:28:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-12T12:16:18.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2023-11-23T12:33:15.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-14T09:55:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:56:11.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBProxy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:InstanceNetworkType'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', '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-bp145737x5bi6****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****":"500","rr-tfhfgk5xxx":"200"...}', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DbEndpointAliases',
'in' => 'query',
'schema' => ['description' => 'The description of the proxy terminal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-proxy', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DbEndpointMinSlaveCount',
'in' => 'query',
'schema' => [
'description' => 'The minimum number of reserved instances.'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '2',
'title' => '',
],
],
[
'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******', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidVpcInstanceId', 'errorMessage' => 'The specified VPC instance ID is invalid.', 'description' => ''],
['errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', 'description' => ''],
['errorCode' => 'InvalidEndpointType.Format', 'errorMessage' => 'The specified EndpointType is invalid.', 'description' => 'The value of the EndpointType parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'IncorrectDBInstanceNetType', 'errorMessage' => 'The current database instance network type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['errorCode' => 'EndpointNum.Error', 'errorMessage' => 'The number of endpoint is invalid.', 'description' => 'The number of proxy terminals is not supported. Check the maximum number of proxy terminals that are allowed.'],
['errorCode' => 'EndpointTypeOperation.NotSupport', 'errorMessage' => 'The endpoint type does not support the operation.', 'description' => 'The operation is not supported for the type of proxy terminal that you configure.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'ClusterEndpoint.StatusNotValid', 'errorMessage' => 'The cluster endpoint status is invalid.', 'description' => 'The status of the endpoint is invalid.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => ''],
],
403 => [
['errorCode' => 'MaxScaleLevel.NotSupport', 'errorMessage' => 'The current maxscale ins_num does not support this operation.', 'description' => 'The operation failed. The specifications of the database proxy are low.'],
['errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The current database instance does not contain any read only instance.', 'description' => 'The current database instance does not have a read-only instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'The current KindCode of the custins does not support the operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database instance state does not support the operation.', 'description' => 'The operation failed. The RDS instance is not running.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Please check the endpoint config parameter.', 'description' => 'Please check the endpoint configuration parameter.'],
['errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', 'description' => 'The operation failed. The RDS instance is not attached with read-only RDS instances.'],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'EndpointType.NotFound', 'errorMessage' => 'The specified endpoint type is not found.', 'description' => 'The operation failed. Unknown types of proxy terminals are detected.'],
['errorCode' => 'InvalidReadDBInstance.NotFound', 'errorMessage' => 'The specified read only database instance does not exist.', 'description' => 'The read-only RDS instance is not created, or the values of the request parameters are invalid.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified Weight is invalid.', 'description' => 'The weight is invalid.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2025-02-27T15:31:18.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-12-26T03:06:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-12-13T09:26:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-11-26T16:57:00.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-03-13T11:50:02.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:56:05.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyEndpoint'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBProxyEndpoint',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['errorCode' => 'InvalidPort.Malformed', 'errorMessage' => 'Specified port is not valid.', 'description' => 'The port number is invalid.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => ''],
['errorCode' => 'InvalidConnectionStringOrPort.Duplicate', 'errorMessage' => 'Specified connection string or port want to be modified is the same with current net type.', 'description' => 'The endpoint or the port number is duplicate. Modify the endpoint or the port number.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'OtherEndpoint.Exist', 'errorMessage' => 'Other endpoint already exist.', 'description' => ''],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter', 'description' => 'You must enter at least one selectable parameter.'],
['errorCode' => 'InvalidDBProxyConnectStringNetType.NotSupported', 'errorMessage' => 'The Specified DBProxyConnectStringNetType is not supported.', 'description' => 'The specified DBProxyConnectStringNetType value is not supported.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', 'description' => ''],
['errorCode' => 'NetTypeChangeTimesExceeded', 'errorMessage' => 'Exceeding the daily net type change times of the DB instance.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidConnectionString.NotFound', 'errorMessage' => 'Specified connection string or net type is not found.', 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => ''],
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['errorCode' => 'Maxscale.NotFound', 'errorMessage' => 'The related maxscale instance is not found.', 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:55:57.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyEndpointAddress'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBProxyEndpointAddress',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:DBProxyConnectStringNetType'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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' => 'exclusive', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A deprecated parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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-hangzhou-c', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'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********', 'title' => ''],
'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****', 'title' => ''],
'destVpcId' => ['description' => 'The target vpc id corresponding to the proxy instance migration.', 'type' => 'string', 'required' => false, 'example' => 'vpc-2vcicu73rdylp****', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'ErrorMxsServiceInsNum.Error', 'errorMessage' => 'The Maxscale serviceIns num must be 1.', 'description' => ''],
['errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', 'description' => 'The task already exists.'],
['errorCode' => 'InvalidVSwitchIds', 'errorMessage' => 'Specified vSwitchId is invalid.', 'description' => 'The specified vSwitchId is invalid.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'InvalidDBProxyNodes.AzProximity', 'errorMessage' => 'current proxy is open az proximity and target proxy not support az proximity.', 'description' => '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.', 'description' => 'Generic proxy does not support more than 2 nodes.'],
['errorCode' => 'InvalidTargetAvailabilityZone', 'errorMessage' => 'All endpoint vswitchId must be in the target availability zone.', 'description' => 'The vswitchId of all connection addresses must be in the target Availability Zone.'],
['errorCode' => 'InvalidDBProxyNodes.Node', 'errorMessage' => 'must set DBProxyNodes params with more than 2 proxy nodes.', 'description' => 'must set DBProxyNodes params with more than 2 proxy nodes.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneIdAndNodeCounts', 'errorMessage' => 'The number of node count and zone count is mismatch.', 'description' => 'The number of zones or nodes is invalid.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneId', 'errorMessage' => 'The number of zone is request 1 or 2.', 'description' => 'The ZoneId of the DBProxyNodes field can only be one or two zones.'],
['errorCode' => 'InvalidMigrateAZInfo', 'errorMessage' => 'Invalid MigrateAZ params.', 'description' => 'The MigrateAZ parameter is invalid.'],
['errorCode' => 'InvalidDBProxyNodes.ZoneIdNotUnique', 'errorMessage' => 'ZoneIds is not unique.', 'description' => 'The Availability Zone ID is not unique.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => ''],
['errorCode' => 'InvalidEndPoint.Format', 'errorMessage' => 'The specified EndPoint is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'MappingInstanceLevel.NotFound', 'errorMessage' => 'Can not find the mapping instance level.', 'description' => 'The mapping instance specification was not found.'],
],
403 => [
['errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'Current DB instance status should be active.', 'description' => 'The operation failed. Check the status of the RDS instance.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.', 'description' => 'The operation failed. The number of proxy terminals that you configure is not supported for the instance type. Check the number of data shards and the number of proxy terminals.'],
['errorCode' => 'NotHaveProxy', 'errorMessage' => 'The current instance does not have a proxy.', 'description' => ''],
['errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'MaxscaleInstanceNotSupport', 'errorMessage' => 'Instances with maxscale instance do not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', 'description' => 'The target Availability Zone does not have enough resources.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-02-28T09:13:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-27T15:31:18.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-15T10:13:07.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-07-12T07:34:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-07T11:24:56.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-25T15:38:45.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-01-09T11:20:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-15T01:47:26.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-07T06:10:37.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDBProxyInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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.XX.XX,k3ecstest', 'title' => ''],
],
[
'name' => 'WhiteListGroupName',
'in' => 'query',
'schema' => ['description' => 'The name of the IP address whitelist.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'DTCSetResult' => ['description' => 'The result of the IP address whitelist configuration. Valid values:'."\n"
."\n"
.'* **Success**'."\n"
.'* **Fail**'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '671B6D32-B907-4EFF-A3B7-94D2EAD5E3A3', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '178968983', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-27T04:15:27.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDTCSecurityIpHostsForSQLServer'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDTCSecurityIpHostsForSQLServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AccessHDMInstanceFailed', 'errorMessage' => 'The specified instance access HDM failed.', 'description' => 'The RDS instance failed to connect to DAS.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidStorageType.NotSupport', 'errorMessage' => 'The current storage type does not support this operation.', 'description' => 'The current storage type does not support this operation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDasInstanceConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDasInstanceConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyDatabaseConfig' => [
'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-t4nnu1my39q******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F5C79A20-E931-5389-BC04-DEBA2D3ABD8D', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'InvalidDatabasePropertyValue', 'errorMessage' => 'Specified value for the database property is not valid.', 'description' => ''],
['errorCode' => 'InvalidDatabaseProperty', 'errorMessage' => 'Specified name for the database property is not valid.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'InvalidDatabaseVersion', 'errorMessage' => 'Specified database property is not compatible with the SQL Server major version.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['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.', 'description' => 'The current login already has a mapped user with the same name in the specific database. Try deleting the existing user and try again.'],
['errorCode' => 'InvalidDiskType', 'errorMessage' => 'Current disk type does not support this operation.', 'description' => 'The current disk type does not support this operation'],
['errorCode' => 'CurrentInsHasColdDB', 'errorMessage' => 'The current instance has cold storage db.', 'description' => 'The current instance has cold storage db. '],
['errorCode' => 'CurrentInsHasColdStorage', 'errorMessage' => 'Current instance has cold storage.', 'description' => 'The current instance has cold storage enabled.'],
['errorCode' => 'ColdDBHasSameNameWithOnlineDB', 'errorMessage' => 'The instance has cold db and online db with the same name.', 'description' => 'The instance has cold db and online db with the same name.'],
['errorCode' => 'DiskSpaceInsufficientForColdOperation', 'errorMessage' => 'Insufficient disk space to bring db online.', 'description' => '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.', 'description' => '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.', 'description' => 'Unable to restore, because the database is in cold storage now. Please skip this database.'],
['errorCode' => 'CurrentDBIsInColdStorage', 'errorMessage' => 'current db is cold db.', 'description' => 'The current db is a cold db'],
['errorCode' => 'ColdDBNumExceedsLimit', 'errorMessage' => 'the number of cold db exceeds the limit.', 'description' => 'The number of cold db exceeds the limit'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
['errorCode' => 'StatisticsUpdateNotSupported', 'errorMessage' => 'Updating statistics is not supported.', 'description' => 'Updating statistics is not supported.'],
],
403 => [
['errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
409 => [
['errorCode' => 'ConflictingDatabaseOperation', 'errorMessage' => 'There is already some operation on the database and the current operation should wait till it is done.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyDatabaseConfig',
'summary' => 'Modifies the property settings of an ApsaraDB RDS for SQL Server instance.',
'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.|',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-02T02:33:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-25T01:28:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T06:07:45.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDatabaseConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F5C79A20-E931-5389-BC04-DEBA2D3ABD8D\\"\\n}","type":"json"}]',
],
'ModifyDbProxyInstanceSsl' => [
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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' => 'ta9um4****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'InvalidDbProxyStatus', 'errorMessage' => 'The proxy status of the database is abnormal.', 'description' => 'The operation failed. The database proxy of the RDS instance is abnormal.'],
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'MaxscaleNotSupport', 'errorMessage' => 'Current custins can not support Maxscale.', 'description' => 'This operation is not supported for instances with maxscale.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'MaxscaleDisabledSSLError', 'errorMessage' => 'Target connectString is not enabled SSL.', 'description' => 'Target connectString is not enabled SSL.'],
],
403 => [
['errorCode' => 'RDSCategoryNotSupport', 'errorMessage' => 'The specified instance category does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectKindCode', 'errorMessage' => 'Current custins kindCode does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance engine and type does not support operations.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'ConnectionStringLengthExceeded', 'errorMessage' => 'Connection String is too long.', 'description' => 'The endpoint is exceedingly long. Modify the endpoint and try again.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'The specified endpoint is not found.', 'description' => ''],
['errorCode' => 'EnabledSSLNotSupport', 'errorMessage' => 'The backend service does not support SSL.', 'description' => 'The backend does not support SSL encryption.'],
['errorCode' => 'InvalidDbProxyConnectionString.NotFound', 'errorMessage' => 'The specified database proxy connection string is not found.', 'description' => 'The operation failed. The database proxy endpoint cannot be found.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'EndpointType.NotFound', 'errorMessage' => 'The specified endpoint type is not found.', 'description' => 'The operation failed. Unknown types of proxy terminals are detected.'],
['errorCode' => 'EndpointConfig.Invalid', 'errorMessage' => 'Please check the endpoint config parameter.', 'description' => 'Please check the endpoint configuration parameter.'],
['errorCode' => 'InvalidMaxscaleConnectionString.NotFound', 'errorMessage' => 'The specified database proxy connection string is not found.', 'description' => 'The operation failed. The database proxy endpoint cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidMaxscaleConnectString.NotFound', 'errorMessage' => 'Specified MaxscaleConnectionString is not found or not belong to this endpoint.', 'description' => '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.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyDbProxyInstanceSsl',
'summary' => 'Configures SSL encryption for an dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-12-19T11:02:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:55:44.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDbProxyInstanceSsl'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyDbProxyInstanceSsl',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:DbProxySslEnabled'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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', 'title' => ''],
],
[
'name' => 'EventId',
'in' => 'query',
'schema' => ['title' => '', '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' => '', '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' => '', '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', 'title' => ''],
'ErrorEventId' => ['description' => 'The error ID.'."\n", 'type' => 'string', 'example' => '12343', 'title' => ''],
'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', 'title' => ''],
'SuccessEventId' => ['description' => 'The ID of the successful event.'."\n", 'type' => 'string', 'example' => '234221', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param.Invalid', 'description' => 'The specified parameter is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEventInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyEventInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'HaDiagnoseConfig.Format', 'errorMessage' => 'The value of tcpConnectionType must be LONG or SHORT', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-07-14T03:17:25.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHADiagnoseConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyHADiagnoseConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'HaConfig.Format', 'errorMessage' => 'The value of HaConfig must be auto or manual', 'description' => 'The value of the HASwitchConfig parameter must be Auto or Manual.'],
['errorCode' => 'HaConfigIsNull', 'errorMessage' => 'HaConfig is null.', 'description' => 'The value of the HASwitchConfig parameter is null.'],
['errorCode' => 'ManualHATime.Format', 'errorMessage' => 'Invalid format of ManualHATime.', 'description' => ''],
['errorCode' => 'ManualHATimeIsNull', 'errorMessage' => 'ManualHATime can not be null when the value of haConfig is Manual.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHASwitchConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyHASwitchConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyImportTask' => [
'summary' => 'Modifies a data import task for an RDS MySQL native replication instance.',
'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' => 'The region ID. Call the DescribeRegions operation to query the latest list of regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. Call the DescribeDBInstances operation to query instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze63v2p3o3k****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'title' => ''],
],
[
'name' => 'Operation',
'in' => 'query',
'schema' => [
'description' => 'The operation to perform. Valid values:'."\n"
."\n"
.'- RETRY\\_IMPORT: Retries the data import task.'."\n"
."\n"
.'- CANCEL: Cancels the data import task.',
'type' => 'string',
'required' => true,
'enum' => ['RETRY_IMPORT', 'CANCEL'],
'example' => 'CANCEL',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response schema.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '069EB9B1-DE12-54B9-8C20-822****', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '41698****', 'title' => ''],
'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'task_1234', 'title' => ''],
'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'IMPORTING', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify Data Import Job ',
'description' => 'Modifies a data import task for an RDS MySQL native replication instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyImportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"069EB9B1-DE12-54B9-8C20-822****\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"task_1234\\",\\n \\"Status\\": \\"IMPORTING\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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',
'enumValueTitles' => [],
'title' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:26:45.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAutoRenewalAttribute'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyInstanceAutoRenewalAttribute',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '50A6059D-6DBB-46C6-A851-1EE93C9013CF', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid.', 'description' => ''],
['errorCode' => 'ParameterAbsence', 'errorMessage' => 'Necessary param is absence.', 'description' => ''],
['errorCode' => 'ParameterLeastAssociate', 'errorMessage' => 'Must input at least one optional parameter.', 'description' => 'The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'OperationDenied.SwitchToCrossRegionBackup', 'errorMessage' => 'Snapshot backup does not support cross region backup storage at present.', 'description' => 'Snapshot backups cannot be stored across regions.'],
['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.', 'description' => 'Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode.'],
['errorCode' => 'OperationDenied.SwitchSnapshotToPhysical', 'errorMessage' => 'Only physical backup to snapshot backup is supported.', 'description' => ''],
['errorCode' => 'UnsupportEncryptedSnapshot', 'errorMessage' => 'Encrypted DB instance snapshot does not support this operation.', 'description' => 'This operation is not supported for encrypted instance snapshots.'],
['errorCode' => 'DstRegionNoUser', 'errorMessage' => 'The user info wasn\'t found destination region, please access the purchase page to initiate registration.', 'description' => 'Unable to find the destination area of user information, please visit the purchase page to start registration.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''],
['errorCode' => 'IncorrectHostType', 'errorMessage' => 'Current DB Instance host type does not support this operation.', 'description' => 'This operation is not supported for the host type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDdrStorage.NotFound', 'errorMessage' => 'Specified Ddr Storage does not exist or not support.', 'description' => ''],
['errorCode' => 'CrossBackupNotSupport', 'errorMessage' => 'Specified region not support cross region backup.', 'description' => 'Cross-zone backup is not supported in the specified region.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidPage.notFound', 'errorMessage' => 'Page not found.', 'description' => 'The specified parameters are not found. Check your parameters.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-09T09:35:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T06:56:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceCrossBackupPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyInstanceCrossBackupPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:BackupEnabled'],
['conditionKey' => 'rds:LogBackupEnabled'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyMaskingRules' => [
'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' => 'The rule configuration, specified as a JSON string.',
'type' => 'object',
'properties' => [
'Columns' => [
'maxItems' => 100,
'description' => 'The list of columns.',
'type' => 'array',
'items' => ['description' => 'An asterisk (`*`) specifies all columns.', 'type' => 'string', 'maxLength' => 100, 'required' => false, 'example' => 'a', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'Databases' => [
'maxItems' => 100,
'description' => 'The list of databases.',
'type' => 'array',
'items' => ['description' => 'An asterisk (`*`) specifies all databases.', 'type' => 'string', 'maxLength' => 100, 'required' => false, 'example' => 'myDB', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'Tables' => [
'maxItems' => 100,
'description' => 'The list of tables.',
'type' => 'array',
'items' => ['description' => 'An asterisk (`*`) specifies all tables.', 'type' => 'string', 'maxLength' => 100, 'required' => false, 'example' => 'myTable', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the rule to modify.', 'type' => 'string', 'required' => true, 'example' => 'rulename1', 'title' => ''],
],
[
'name' => 'MaskingAlgo',
'in' => 'query',
'schema' => ['description' => 'The masking algorithms, specified as a JSON string. You can include multiple algorithms and their parameters, such as encryption position and length.', 'type' => 'string', 'required' => false, 'example' => ' [{"name": "sha256"},'."\n"
.' {"name":"sm4-128-gcm"}]', 'title' => ''],
],
[
'name' => 'DefaultAlgo',
'in' => 'query',
'schema' => ['description' => 'The name of the default masking algorithm.', 'type' => 'string', 'required' => false, 'example' => 'sm4-128-gcm', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The ID of the database instance.', 'type' => 'string', 'required' => true, 'example' => 'rm-t4n8t18o******6d5', 'title' => ''],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the rule is enabled. Valid values: `true` and `false`.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'title' => ''],
],
[
'name' => 'DBName',
'in' => 'query',
'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'myDB', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'The response data.',
'additionalProperties' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'rm-t4n8t18o*****6d5', 'title' => ''],
'type' => 'object',
'title' => '',
'example' => '',
],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8B1434A1-08A7-3E8C-A237-076A********'],
'Success' => ['description' => 'Whether the request was successful. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', 'description' => 'The value of the parameter is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'errorMessage' => 'The instance has not enabled the column encryption service.', 'description' => ''],
],
403 => [
['errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', 'description' => 'The parameter is not found for the interface.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify encryption or desensitization rule',
'summary' => 'Modifies the encryption or data masking rule for a specified instance.',
'description' => '## Usage notes'."\n"
."\n"
.'- Before you call this API, ensure that the column encryption service is enabled in DAS Security Center.'."\n"
."\n"
.'- If you receive the `ColumnEncryptionErrorCode.NOT_PURCHASED` error, go to the DAS (Database Autonomy Service) Security Center, purchase and enable the column encryption service, and then call the API again.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyMaskingRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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=192.168.XX.XX ldapbasedn="CN=Users,DC=pgsqldomain,DC=net" ldapbinddn="CN=pgadminuser,CN=Users,DC=pgsqldomain,DC=net" ldapbindpasswd="Test123!" ldapsearchattribute="sAMAccountName"', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 1000,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'HbaItem.InvalidType', 'errorMessage' => 'Specified hba item type is invalid.', 'description' => ''],
['errorCode' => 'HbaItem.InvalidMethod', 'errorMessage' => 'Specified hba item auth method is invalid.', 'description' => ''],
['errorCode' => 'HbaItem.InvalidIPMask', 'errorMessage' => 'Specified hba item ip mask is invalid.', 'description' => ''],
['errorCode' => 'HbaItem.InvalidPriority', 'errorMessage' => 'Specified hba item priorityId is out of range or duplicate.', 'description' => ''],
['errorCode' => 'HbaItemOpsType.Invalid', 'errorMessage' => 'Specified hba opsType is invalid.', 'description' => ''],
['errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid', 'description' => ''],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidIP.Format', 'errorMessage' => 'The specified IP address is illegal or invalid.', 'description' => 'The specified IP address is illegal or invalid'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'HbaItemPriorityIdAlreadyExist', 'errorMessage' => 'Specified hba item priorityId is exist.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'HbaItemPriorityIdNotFound', 'errorMessage' => 'Specified hba item priorityId is not found.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2022-02-14T06:22:16.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-11-23T12:09:14.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPGHbaConfig'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyPGHbaConfig',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyParameter' => [
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'PendingActionOverdue', 'errorMessage' => 'the action execution time is already overdue', 'description' => 'The specified execution time has expired.'],
['errorCode' => 'EngineMigration.ActionDisabled', 'errorMessage' => 'Specified action is disabled while custins is in engine migration.', 'description' => 'The specified operation is disabled when the instance is being migrated across engines.'],
['errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', 'description' => ''],
['errorCode' => 'Invalid.ParamGroupDBCategory', 'errorMessage' => 'ParamGroup category is basic, not standard.', 'description' => 'The parameter group is a basic parameter group not a standard parameter group.'],
['errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'StorageEngine.NotSupported', 'errorMessage' => 'Current instance storage engine dose not support this operation.', 'description' => ''],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'SystemParamGroupCode.Format', 'errorMessage' => 'Specific DBParamGroupId is not valid.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'InvalidInstanceParameter', 'errorMessage' => 'Specified name for the instance parameter is not valid.', 'description' => 'The name specified for the instance parameter is invalid.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidParameters', 'errorMessage' => 'Group Replication limits parameters and does not support modification.', 'description' => 'The group Replication has restrictions on parameters and cannot be modified.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'OperationDenied.XengineSwitch', 'errorMessage' => 'Current custins can not turn off xengine param.', 'description' => 'The current instance has a xengine table and cannot switch to another parameter template.'],
['errorCode' => 'InvalidParameterValue.Limit', 'errorMessage' => 'Parameter value exceeds limit.', 'description' => ''],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The current database instance type does not support the operation.', 'description' => 'This operation is not supported for the database engine of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current database status does not support the operation.', 'description' => 'The operation failed. The RDS instance is not running.'],
['errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', 'description' => ''],
['errorCode' => 'Invalid.Parameter', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The specified parameter is invalid.'],
['errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', 'description' => 'The value of the EffectiveTime parameter is invalid.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'errorMessage' => 'Group Replication requires the ClassCode of each node to be consistent.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidNodeNum', 'errorMessage' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.InvalidXengine', 'errorMessage' => 'Group Replication is not supported because the instance has xengine tables.', 'description' => ''],
['errorCode' => 'GroupReplicationNotSupport.MemoryTooSmall', 'errorMessage' => 'Group Replication is not supported because the memory is too small.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'errorMessage' => 'Group Replication is not supported because the instance exists table has no primary key.', 'description' => 'The instance has tables without primary keys and does not support MySQL group replication (MGR).'],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyParameter',
'summary' => 'Modifies the parameter values of an instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T06:05:54.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-22T03:09:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-23T06:44:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-03T09:07:04.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-27T07:09:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-21T05:50:41.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-06-28T08:03:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-20T15:38:12.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-09T13:07:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-25T03:14:32.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-16T07:10:37.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-16T07:10:37.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2021-10-26T15:39:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-26T15:39:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-26T15:39:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-26T15:39:59.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyParameter',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:TLSVersion'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'ParameterGroupId' => ['description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'rpg-13ppdh****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '857DC00B-7B85-4853-8B27-AD65EB618BC6', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameters.Malformed', 'errorMessage' => 'The specified parameter "Parameters" is not valid.', 'description' => ''],
['errorCode' => 'ParamGroupsNotExist', 'errorMessage' => 'This paramGroups not exist', 'description' => ''],
['errorCode' => '%s', 'errorMessage' => 'The following parameters are prohibited:
%s', 'description' => ''],
['errorCode' => 'ParamGroupsNameInvalid', 'errorMessage' => 'The parameter group name is invalid.', 'description' => 'The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter.'],
['errorCode' => 'InvalidParameterGroupId.Malformed', 'errorMessage' => 'Specified parameterGroupId is not valid.', 'description' => 'The parameter template ID that is specified by the parameterGroupId parameter is invalid. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.'],
['errorCode' => 'ParamGroupsNotExistOrTypeNotSupport', 'errorMessage' => 'The parameter group does not exist or its type is not supported.', 'description' => 'The paramGroups does not exist or its type is not supported.'],
['errorCode' => 'ParamNotExist', 'errorMessage' => 'This param Not Exist', 'description' => 'The parameter does not exist. Check parameter configurations.'],
['errorCode' => 'ParamTypeError', 'errorMessage' => 'The parameter type error.', 'description' => 'The parameter type is invalid.'],
['errorCode' => 'ParamGroupsDescInvalid', 'errorMessage' => 'The maximum length of parameter group description is exceeded.', 'description' => 'The description of the parameter template can be up to 200 characters in length.'],
['errorCode' => 'InvalidParameterValue.NotStandard', 'errorMessage' => 'Invalid parameter format.', 'description' => 'The value of the parameter is invalid.'],
['errorCode' => 'InvalidParameters.Prohibited', 'errorMessage' => 'Specified parameter is not valid: %s.', 'description' => 'Parameter is illegal, please check.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-07-23T05:40:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T03:57:54.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-25T01:51:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2023-05-09T13:07:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-01T09:00:35.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameterGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyParameterGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifyParameterTimedScheduleTask' => [
'summary' => 'Change the effective time of a scheduled parameter modification task.',
'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' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'pgm-bp102g323jd4****', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '440437220', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The scheduled switch time in UTC, in yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'required' => false, 'example' => '2022-05-06T09:24:00Z', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The returned data.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'ScheduleTask.NotFound', 'errorMessage' => 'Parameter modification timed task not found.', 'description' => ''],
['errorCode' => 'ScheduleTask.OperationFailed', 'errorMessage' => 'Parameter modification timed task operation failed.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify Scheduled Task for Parameter Modification',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'### Related feature documentation'."\n"
."\n"
.'>'."\n"
."\n"
.'Before calling this API, read the feature documentation to understand its prerequisites and effects.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Set instance parameters for RDS MySQL](~~96063~~)'."\n"
."\n"
.'- [Set instance parameters for RDS PostgreSQL](~~96751~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyParameterTimedScheduleTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\"\\n}","type":"json"}]',
],
'ModifyRCDiskAttribute' => [
'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' => 'Region ID. You can invoke DescribeRegions to obtain it.', 'description' => 'The region ID. You can call the `DescribeRegions` operation to obtain the latest list of regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['title' => 'The ID of the disk whose property you want to modify.', 'description' => 'The ID of the disk whose attributes you want to modify.', 'type' => 'string', 'required' => true, 'example' => 'rcd-wz9c8isqly8637zw****'],
],
[
'name' => 'DiskName',
'in' => 'query',
'schema' => ['title' => 'Disk name. The name must be 2 to 128 characters in length and can contain characters from the letter categorization in Unicode (including English letters, Chinese characters, and digits). It can also include colons (:), underscores (_), periods (.), or hyphens (-).', 'description' => 'The new name for the disk. The name must be 2 to 128 characters in length and can contain letters, Chinese characters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'testDisk'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => 'The description of the disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.', 'description' => 'The new description for the disk. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'DeleteWithInstance',
'in' => 'query',
'schema' => ['title' => 'Specifies whether the disk is released when its associated instance is released. Default value: none, which means the current setting remains unchanged.'."\n"
."\n"
.'This parameter cannot be set for disks with the multi-attach feature enabled.'."\n"
."\n"
.'An error occurs if you set DeleteWithInstance to false in either of the following cases:'."\n"
."\n"
.'- The disk category is local disk (ephemeral).'."\n"
.'- The disk category is basic disk (cloud) and the disk is non-portable (Portable=false).'."\n"
."\n"
.'Warning'."\n"
.'If you set DeleteWithInstance to false, but the ECS instance to which the disk is attached is security locked (indicated by "LockReason": "security" in OperationLocks), the disk will be released together with the instance regardless of the DeleteWithInstance setting when the instance is released.', 'description' => 'Specifies whether to release the disk when its associated instance is released. If you do not specify this parameter, the current setting remains unchanged.'."\n"
."\n"
.'You cannot set this parameter for cloud disks that have the multi-attach feature enabled.'."\n"
."\n"
.'Setting `DeleteWithInstance` to `false` returns an error in the following cases:'."\n"
."\n"
.'The disk is an ephemeral disk (`ephemeral`), or the disk is a non-detachable (`Portable=false`) cloud disk. **Warning**: If you set `DeleteWithInstance` to `false`, the disk is still released with the instance if the instance is protected by a security lock (`"LockReason": "security"` in `OperationLocks`). In this case, the `DeleteWithInstance` setting is ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'BurstingEnabled',
'in' => 'query',
'schema' => ['title' => 'Specifies whether to enable the burst (performance burst) feature for disks that support it. Valid values:'."\n"
."\n"
.'true: Enabled.'."\n"
.'false: No.'."\n"
.'Note'."\n"
.'If you specify any value for a disk that does not support the burst feature, an error is returned.', 'description' => 'Specifies whether to enable performance bursting for a disk that supports this feature.'."\n"
."\n"
.'Valid values: `true` and `false`. **Note**: This operation returns an error if you specify this parameter for a disk that does not support performance bursting.', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRegionId.MalFormed', 'errorMessage' => 'The specified parameter RegionId is not valid.', 'description' => 'The specified RegionId is illegal.'],
['errorCode' => 'InvalidDiskName.Malformed', 'errorMessage' => 'The specified disk name is wrongly formed.', 'description' => 'The disk name format is incorrect. It can be 2 to 128 characters in length and start with an English letter or a Chinese letter. It can contain digits, periods (.), underscores (_), or hyphens (-). Cannot start with http:// and https.'],
['errorCode' => 'NoAttributeToModify', 'errorMessage' => 'No attribute to be modified in this request.', 'description' => 'No properties were modified.'],
['errorCode' => 'IncompleteParamter', 'errorMessage' => 'Some fields can not be null in this request.', 'description' => 'Missing parameter in request.'],
['errorCode' => 'MissingParameter.DiskIdOrDiskIds', 'errorMessage' => 'Specified parameter DiskId or DiskIds is missing.', 'description' => 'The specified parameter DiskId or DiskIds is missing.'],
['errorCode' => 'BurstingEnabledForDiskCategoryUnsupported', 'errorMessage' => 'The specified disk category does not support bursting enabled.', 'description' => 'The specified disk type does not support enabling the performance burst feature.'],
['errorCode' => 'BurstingEnabledForMultiAttachDiskUnsupported', 'errorMessage' => 'The multi attach disk does not support bursting enabled.', 'description' => 'Multi-mount disks do not support the performance burst feature.'],
['errorCode' => 'BurstingEnabledForModifyingDiskUnsupported', 'errorMessage' => 'The modifying disk does not support bursting enabled.', 'description' => 'Disks in the transition configuration are not allowed to modify the burst property.'],
['errorCode' => 'InvalidBurstingEnabled.DiskSizeTooSmall', 'errorMessage' => 'The disk size must be greater than 3 GiB to enable burst.', 'description' => 'Performance burst can only be enabled when the disk size exceeds 3GiB.'],
],
403 => [
['errorCode' => 'QuotaExceed.Snapshot', 'errorMessage' => 'The snapshot quota exceeds.', 'description' => 'The snapshot quota exceeds the limit. If you want to store new snapshots, delete the existing old snapshots without affecting your business.'],
['errorCode' => 'DiskNotPortable', 'errorMessage' => 'The specified disk is not a portable disk.', 'description' => 'The specified disk is not an unmountable disk. A disk with a Portable of false cannot be unmounted.'],
['errorCode' => 'IncorrectDiskStatus', 'errorMessage' => 'The operation is not supported in this status.', 'description' => 'The current disk does not support this operation. Please check whether the disk is in normal use and is in arrears.'],
['errorCode' => 'UserNotInTheWhiteList', 'errorMessage' => 'The user is not in disk white list.', 'description' => 'You are not in the disk whitelist. Please add it to the whitelist and try again.'],
['errorCode' => 'DeleteWithInstance.Conflict', 'errorMessage' => 'Multi attach disk cannot be set to DeleteWithInstance attribute.', 'description' => 'Cloud disks with the multi-mount feature enabled do not support setting DeleteWithInstance.'],
],
[
['errorCode' => 'InvalidDiskId.NotFound', 'errorMessage' => 'The specified disk does not exist.', 'description' => 'The specified disk does not exist. Please check whether the disk ID is correct.'],
['errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified description is wrongly formed.', 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'Specified attached instance does not exist.', 'description' => 'The specified instance does not exist. Check whether the instance ID is correct.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify block storage properties',
'summary' => 'Modifies the attributes of a block storage device, such as its name, description, whether it is released with its instance, and whether performance bursting is enabled.',
'description' => 'Call this operation to modify attributes of a block storage device, such as its name, description, or whether it is released with its instance, by specifying the disk ID.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyRCDiskAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","type":"json"}]',
],
'ModifyRCDiskSpec' => [
'summary' => 'Modifies the disk type or performance level (PL) of the cloud disks 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 ID of the region in which the instance resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['description' => 'The cloud disk ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rcd-wz9f3peueu5npsl****', 'title' => ''],
],
[
'name' => 'DiskCategory',
'in' => 'query',
'schema' => ['description' => 'The new disk type. Valid values:'."\n"
."\n"
.'* **cloud_essd**: ESSD.'."\n"
.'* **cloud_auto**: ESSD AutoPL disk'."\n"
."\n"
.'This parameter is empty by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'default' => 'cloud_essd', 'title' => ''],
],
[
'name' => 'PerformanceLevel',
'in' => 'query',
'schema' => ['description' => 'The PL of the disk. Valid values:'."\n"
."\n"
.'* **PL1** (default): A single ESSD can deliver 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' => 'PL2', 'title' => ''],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n"
."\n"
.'* **true (default)**: automatically completes the 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 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' => 'true', 'default' => 'true', 'title' => ''],
],
[
'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 the request parameters, request syntax, 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', 'default' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF'],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24505392472****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
['errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', 'description' => 'The parameter PerformanceLevel of the specified data disk is invalid.'],
['errorCode' => 'InvalidDiskCategory.ValueNotSupported', 'errorMessage' => 'Specified disk category is not supported.', 'description' => ''],
['errorCode' => 'OperationDenied', 'errorMessage' => 'The specified image contains the snapshot of the data disk,does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => 'The instanceType of the specified instance does not support this disk category.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type 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.', 'description' => ''],
['errorCode' => 'OperationDenied.PerformanceLevelNotMatch', 'errorMessage' => 'The specified PerformanceLevel and disk size do not match.', 'description' => 'The specified performance level does not match the disk size.'],
['errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', 'description' => ''],
['errorCode' => 'OperationDenied.NoStock', 'errorMessage' => 'The requested resource is sold out in the specified zone, try other types of resources or other regions and zones.', 'description' => 'Inventory is insufficient.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\",\\n \\"OrderId\\": 0\\n}","type":"json"}]',
'title' => 'ModifyRCDiskSpec',
'description' => '> To minimize the impacts on your business, we recommend that you change specifications during off-peak hours.'."\n"
."\n"
.'Take note of the following items:'."\n"
."\n"
.'* For a pay-as-you-go Enterprise SSD (ESSD), you can upgrade or downgrade its PL. However, you cannot downgrade the performance level to PL0.'."\n"
.'* The ESSD must be in the In Use (In_Use) or Unattached (Available) state.'."\n"
.'* If the ESSD is attached to an instance, the instance must be in the Running or Stopped state. The instance cannot be in the Expired state or stopped due to overdue payments.'."\n"
.'* The performance level of an ESSD is limited by the capacity of the ESSD. If you cannot upgrade the PL of an ESSD, you can expand the capacity of the ESSD.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'ModifyRCInstance' => [
'summary' => 'ModifyRCInstance',
'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', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
],
[
'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", 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'RebootWhenFinished',
'in' => 'query',
'schema' => ['description' => 'Whether to restart the instance immediately after the upgrade/downgrade operation ends. Valid values:'."\n"
.'- **true** (default): Yes.'."\n"
.'- **false**: No.'."\n"
.'> If the instance is in the **paused** status, it remains in that status even if you set `RebootWhenFinished=true`, and the restart operation will not be executed.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RebootTime',
'in' => 'query',
'schema' => ['description' => 'The restart time of the instance.'."\n"
."\n"
.'- If **RebootWhenFinished** is set to **false**, you **must** specify a restart time within 48 hours.'."\n"
.'- The time must follow the ISO 8601 standard in UTC+0. Format: `yyyy-MM-ddTHH:mmZ`.', 'type' => 'string', 'required' => false, 'example' => '2025-04-03T12:05Z', 'title' => ''],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically use a coupon. Valid values:'."\n"
.'* **true** (default): Yes.'."\n"
.'* **false**: No.'."\n"
."\n"
.'> If you use a coupon and later decrease the quota, the amount offset by the coupon will not be refunded.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '72329885****', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CallEcsApi.Failure', 'errorMessage' => 'Fail to call ECS API.', 'description' => 'Failed to call the ECS api.'],
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['errorCode' => 'InvalidInstanceType.ValueNotSupported', 'errorMessage' => 'The specified InstanceType does not exist or beyond the permitted range.', 'description' => 'The specified InstanceType does not exist or beyond the permitted range.'],
['errorCode' => 'InvalidInstanceStatus.NotStopped', 'errorMessage' => 'The specified Instance status is not stopped.', 'description' => 'The specified Instance status is not stopped.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DependencyViolation.InstanceType', 'errorMessage' => 'The current InstanceType cannot be changed to the specified InstanceType.', 'description' => 'The specification of the current instance cannot be changed to the specified specification.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
],
403 => [
['errorCode' => 'OperationDenied', 'errorMessage' => 'The requested instance is out of resources.', 'description' => 'Insufficient resources. Contact on-duty engineers to increase the inventory.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnexpectedSwitchTime', 'errorMessage' => 'SwitchTime should not be null when switch at timePoint mode', 'description' => 'The switchover time cannot be left unspecified when you configure ApsaraDB RDS to perform a switchover at a specified point in time.'],
['errorCode' => 'OperationDenied.NoStock', 'errorMessage' => 'The requested resource is sold out in the specified zone, try other types of resources or other regions and zones.', 'description' => 'Inventory is insufficient.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => ''],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Upgrade or Decrease the Quota of an RDS Custom Instance',
'description' => 'Before using this API, ensure that you fully understand the metering method, Pricing, and refund rules for decreasing the quota of RDS Custom instances.'."\n"
."\n"
.'When invoking this API, note the following:'."\n"
.'- You cannot modify the instance type of an expired instance. You can renew the instance and try again.'."\n"
.'- Only **Standard Edition disk instances** support changing the instance type.'."\n"
.'- When upgrading or decreasing the quota of the instance type, note the following:'."\n"
.' - The instance must be in the **running** (Running) or **stopped** (Stopped) status.'."\n"
.' - The price difference between the original and new instance types will be refunded to your original payment method. Coupons already used will not be returned.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyRCInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 100789370230206,\\n \\"RequestId\\": \\"6EF82B07-28D2-48D1-B5D6-7E78FED277C7\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'name' => 'IncludeDataDisks',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance or disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rc-dh2jf9n6j4s14926****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'default' => 'true', 'title' => ''],
],
[
'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', 'default' => 'PrePaid', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['description' => 'The additional business information about the instance.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'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', 'default' => 'true', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'example' => '72802442****', 'title' => ''],
],
],
'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', 'title' => ''],
'Fee' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
'InstanceId' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6EF82B07-28D2-48D1-B5D6-7E78FED277C7', 'title' => ''],
'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"]', 'title' => ''],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
'ChargeType' => ['description' => 'The billing method.'."\n"
.'* **POSTPAY**: pay-as-you-go.'."\n"
.'* **PREPAY**: subscription.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '2133400000****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidInstanceUseType.NotSupport', 'errorMessage' => 'Specified instanceUseType does not support in RDS.', 'description' => 'The operation failed. The role that is specified by the instanceUseType parameter is not supported for the RDS instance.'],
['errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', 'description' => ''],
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', 'description' => 'The specified order task already exists.'],
['errorCode' => 'InvalidOldInstanceType.NotSupport', 'errorMessage' => 'Specified oldInstanceType does not support in RDS.', 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', 'description' => 'The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.'],
['errorCode' => 'InvalidResource.Format', 'errorMessage' => 'The specified parameter Resource is not valid.', 'description' => 'The resource ID is invalid.'],
['errorCode' => 'InvalidPayType.Format', 'errorMessage' => 'The specified parameter PayType is not valid.', 'description' => 'The payment type is invalid.'],
['errorCode' => 'InvalidUsedTime.Format', 'errorMessage' => 'The specified parameter UsedTime is not valid.', 'description' => 'UsedTime is not defined.'],
['errorCode' => 'InsufficientQuota.NoEnough', 'errorMessage' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', 'description' => 'The quota is insufficient. Contact your channel partner to request a quota increase.'],
['errorCode' => 'SYSTEM.ILLEGALARGUMENT', 'errorMessage' => 'The current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.', 'description' => ''],
['errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', 'description' => ''],
['errorCode' => 'ContainForbiddenLabel.error', 'errorMessage' => 'There is a label that prohibits placing an order, and the order cannot be placed.', 'description' => ''],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => '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.', 'description' => '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.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the subscription limit. You are not allowed to switch to the subscription method.'],
['errorCode' => 'InvalidParam.POSTPAY', 'errorMessage' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', 'description' => 'When the classic network is offline, the current instance is of the classic network type and has exceeded the time limit of the post-payment instance. You cannot switch the payment method to post-payment.'],
['errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', 'description' => 'You currently have outstanding bills, please settle them first.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'The delete protection function can only be used on pay-as-you-go resources.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidRCInstanceID.NotFound', 'errorMessage' => 'The specified custom instanceID is not valid.', 'description' => 'The passed instance ID does not belong to the custom instance.'],
['errorCode' => 'Invalid.UsedTimeFormat', 'errorMessage' => 'The specified UsedTime is not valid.', 'description' => 'The specified conversion duration is invalid'],
['errorCode' => 'Invalid.PayTypeFormat', 'errorMessage' => 'The specified PayType is not valid.', 'description' => 'The specified payment type is invalid.'],
['errorCode' => 'Invalid.SpotStrategyFormat', 'errorMessage' => 'The specified SpotStrategy SpotAsPriceGo is not valid.', 'description' => 'Preemptible instances do not support'],
['errorCode' => 'Invalid.PeriodAndUsedTimeFormat', 'errorMessage' => 'The specified Period and UsedTime is not valid.', 'description' => 'When billing is a year, it cannot exceed this time.'],
['errorCode' => 'Invalid.DiskFormat', 'errorMessage' => 'The specified disk is not attached to instance id.', 'description' => 'The cloud disk is not mounted on the instance and cannot be converted to the billing method.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'InvalidDisk.SystemDiskFormat', 'errorMessage' => 'The specified system disk does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', 'description' => 'Elastic temporary disk does not support this operation'],
['errorCode' => 'InvalidEEDDisk.NotSupport', 'errorMessage' => 'The specified eed category does not support this operation.', 'description' => 'Flexible temporary disk does not support this operation'],
],
403 => [
['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance locked.', 'description' => 'The operation failed. The RDS instance is locked possibly because the balance within your Alibaba Cloud account is insufficient. Top up or add funds to your Alibaba Cloud account to unlock the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'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"}]',
],
'ModifyRCInstanceDescription' => [
'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', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-m5ei7b1w38w2l91x****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ModifyRCInstanceDescription',
'summary' => 'Modifies the name of an RDS Custom instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyRCInstanceDescription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCECD3CD-AB2D-4F6D-BEDE-47BC90A398D2\\"\\n}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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-m5****rw.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => 'The port that is associated with the read/write splitting endpoint.'."\n", 'type' => 'string', 'required' => false, 'example' => '3306', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => '{'."\n"
.' "rm-bp1****": 800,'."\n"
.' "master": 400,'."\n"
.' "slave": 400'."\n"
.'}', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ReadUniformNetTypeNotExists', 'errorMessage' => 'The specified uniform read only network type does not exist.', 'description' => 'The operation failed. The unified network type that you specify for the read-only RDS instances cannot be found.'],
['errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The Current DB Instance has not read-only instance.', 'description' => 'The database instance does not have any read-only instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'ReadDBInstance.NotFound', 'errorMessage' => 'The current database instance does not contain any read only instance.', 'description' => 'The current database instance does not have a read-only instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyReadWriteSplittingConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyReadWriteSplittingConnection',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-bp****', 'title' => ''],
],
[
'name' => 'ReadSQLReplicationTime',
'in' => 'query',
'schema' => ['description' => 'The replication latency of the data replication. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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-bp****', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BBB11B5A-7B37-493A-87E6-490BCB7BDF98', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '241535739', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.DBInstanceType', 'errorMessage' => 'The operation is not permitted due to type of instance.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:05.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyReadonlyInstanceDelayReplicationTime'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyReadonlyInstanceDelayReplicationTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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-ac****', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '例如Custom默认资源为Instance',
'enum' => [],
'description' => 'The resource type.'."\n",
'title' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', 'description' => 'The resource group ID cannot be found. Check the resource group ID.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-12-16T14:09:57.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyResourceGroup'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/{#InstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidSqlLog.Malformed', 'errorMessage' => 'The specified parameter SqlLog is not valid.', 'description' => ''],
['errorCode' => 'InvalidConfigName', 'errorMessage' => 'The ConfigName is not valid.', 'description' => ''],
['errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'IncorrectPerfFrequencyType', 'errorMessage' => 'Current DB instance does not support this perf frequency.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'ErrorMxsServiceInsNum.Error', 'errorMessage' => 'The Maxscale serviceIns num must be 1.', 'description' => ''],
['errorCode' => 'IncorrectSQLLogVersion', 'errorMessage' => 'Current DB instance SQL log version does not support this operation.', 'description' => 'This operation is not supported for the SQL log version of the current instance.'],
['errorCode' => 'IncorrectSQLLogActiveStatus', 'errorMessage' => 'Current DB instance SQL log active status does not support this operation.', 'description' => 'The operation failed. The RDS instance is running.'],
['errorCode' => 'OperationDenied.QuotaInsufficient', 'errorMessage' => 'The DAS Enterprise Edition (V1) quota is insufficient.', 'description' => 'The DAS Enterprise Edition (V1) quota is insufficient.'],
['errorCode' => 'OperationDenied.OperateFrequently', 'errorMessage' => 'The modification operation is too frequent.', 'description' => 'The modification operation is too frequent.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'description' => '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.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'InvalidSqlRetention.Malformed', 'errorMessage' => 'Specified sql retention is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
504 => [
['errorCode' => 'OperationDenied.Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => 'Request failed due to timeout processing'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-23T05:36:35.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-09T13:35:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-16T03:19:52.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-20T15:14:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorPolicy'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifySQLCollectorPolicy',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'ModifySQLCollectorRetention' => [
'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 operation to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'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"
."\n"
.'- 180: 180 days'."\n"
."\n"
.'- 365: one year'."\n"
."\n"
.'- 1095: three years'."\n"
."\n"
.'- 1825: five years', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '365', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '21383BB3-3845-4628-B422-B4FB5C83DEBD', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConfigValue', 'errorMessage' => 'The ConfigValue is not valid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'IncorrectSQLLogActiveStatus', 'errorMessage' => 'Current DB instance SQL log active status does not support this operation.', 'description' => 'The operation failed. The RDS instance is running.'],
['errorCode' => 'InvalidSqlRetention.Malformed', 'errorMessage' => 'Specified sql retention is not valid.', 'description' => ''],
['errorCode' => 'IncorrectSQLLogVersion', 'errorMessage' => 'Current DB instance SQL log version does not support this operation.', 'description' => 'This operation is not supported for the SQL log version of the current instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifySQLCollectorRetention',
'summary' => 'Changes the retention period of the log files that are generated by the SQL Explorer feature for an ApsaraDB RDS instance.',
'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~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorRetention'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifySQLCollectorRetention',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21383BB3-3845-4628-B422-B4FB5C83DEBD\\"\\n}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'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', 'title' => ''],
'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'SecurityGroupId' => ['description' => 'The ID of the ECS security group.'."\n", 'type' => 'string', 'example' => 'sg-****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8585861B-8F0D-4D17-9460-C42255EB10C0', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'AssociatedEcsSecurityGroupIdQuotaExceed', 'errorMessage' => 'Security groups quota exceeded', 'description' => 'The operation failed. The number of security groups that are configured for the RDS instance exceeds the quota.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidEcsSecurityGroupId', 'errorMessage' => 'Specified ecs security group id is not valid.', 'description' => 'The specified ECS security group ID is invalid.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityGroupConfiguration'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifySecurityGroupConfiguration',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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'],
'title' => '',
],
],
[
'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' => 'MIX', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '11585****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectMasterDBInstanceState', 'errorMessage' => 'Master instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidWhitelistNetType.Malformed', 'errorMessage' => 'Specified WhitelistNetType is not valid.', 'description' => 'The specified WhitelistNetworkType is invalid. Please check again.'],
['errorCode' => 'InvalidIPArrayAttribute.Format', 'errorMessage' => 'The format of the IP attribute is invalid.', 'description' => 'The specified DBInstanceIPArrayAttribute parameter is invalid. Specify a valid value and try again. If the value that you specify contains multiple entries, separate the entries with commas (,). Each entry must be unique. Valid entries are in one of the following formats:'."\n"
.'IP address, such as 10.23.12.24.'."\n"
.'CIDR, such as 10.23.12.0/24. In this example, 24 indicates that the prefix in each IP address is 24 bits in length. You can replace 24 with an integer within the range of 1 to 32.'],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'description' => 'The IP address whitelist is invalid. It contains duplicate entries.'],
['errorCode' => 'SecurityIPList.Format', 'errorMessage' => 'Specified SecurityIPList is not valid.', 'description' => 'The specified IP address whitelist is invalid.'],
['errorCode' => 'InvalidGroupName.DuplicatedWithTemplate', 'errorMessage' => 'Sepecified group name is used by whitelist template.', 'description' => 'The whitelist group name conflicts with the whitelist template associated with the instance.'],
['errorCode' => 'InvalidSecurityIPListGroup.QuotaExceeded', 'errorMessage' => 'Specified security IP list group is not valid: Exceeding the allowed amount of group.', 'description' => 'The specified whitelist security group is invalid and exceeds the number of allowed groups.'],
['errorCode' => 'InvalidDBInstanceType.Format', 'errorMessage' => 'Specified instance type is not valid.', 'description' => 'The operation failed. The database engine is invalid. Specify a valid database engine.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBType', 'errorMessage' => 'The current DB type does not support this operation.', 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'Readins.NotFound', 'errorMessage' => 'The current instance does not contain any read only instance. The operation is not supported.', 'description' => 'The operation failed. The RDS instance is not attached with read-only RDS instances.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-19T07:40:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-09-11T10:20:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-03-25T06:44:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-30T06:17:58.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-09-26T08:14:54.000Z', 'description' => 'Error codes changed, Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifySecurityIps',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ModifyTaskInfo' => [
'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. You can call the [DescribeRegions](~~26243~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID. You can call the DescribeTasks operation to query task IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't-83br18hloum8u3948s', 'title' => ''],
],
[
'name' => 'StepName',
'in' => 'query',
'schema' => ['description' => 'The name of the execution step.', 'type' => 'string', 'required' => false, 'example' => 'ha_switch', 'title' => ''],
],
[
'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.',
'enumValueTitles' => [],
'type' => 'string',
'required' => false,
'example' => 'modifySwitchTime',
'title' => '',
],
],
[
'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"
."\n"
.'- **Immediate**: The task is executed immediately.'."\n"
."\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.', 'type' => 'string', 'required' => false, 'example' => '{"recoverTime":"2023-04-12T18:30:00Z","recoverMode":"timePoint"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', 'title' => ''],
'ErrorTaskId' => ['description' => 'The ID of the failed task. This parameter is returned when a task fails.', 'type' => 'string', 'example' => 't-83br18hlw11ue610yo', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '18B3000C-2B06-5D4F-AA5B-456D5FBCA55B', 'title' => ''],
'SuccessCount' => ['description' => 'The number of completed tasks.', 'type' => 'string', 'example' => '5', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyTaskInfo',
'summary' => 'Modifies information about the historical tasks in the task center.',
'changeSet' => [
['createdAt' => '2024-08-23T08:33:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-07T03:36:55.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTaskInfo'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyTaskInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'ModifyWhitelistTemplate' => [
'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' => '', '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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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, 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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',
'title' => '',
],
'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',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828', 'title' => ''],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidIPList.Format', 'errorMessage' => 'Specified IPList is not valid.', 'description' => ''],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidWhitelistTemplateName.Duplicated', 'errorMessage' => 'Whitelist template name duplicated.', 'description' => ''],
['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.'],
['errorCode' => 'SecurityIPList.Format', 'errorMessage' => 'Specified SecurityIPList is not valid.', 'description' => 'The specified IP address whitelist is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
[
['errorCode' => 'WhitelistIPLength.Forbidden', 'errorMessage' => 'Whitelist ip length exceeeds the limit.', 'description' => ''],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'WhitelistTemplateId.NotFound', 'errorMessage' => 'Whitelist Template id not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'ModifyWhitelistTemplate',
'summary' => 'Edits a whitelist. You can call this operation to create, modify, or delete a whitelist.',
'description' => '### Supported database engines'."\n"
."\n"
.'* RDS MySQL'."\n"
.'* RDS PostgreSQL'."\n"
.'* RDS SQL Server'."\n",
'changeSet' => [
['createdAt' => '2024-05-11T08:59:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-22T09:16:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-11-21T06:07:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-08-17T13:29:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWhitelistTemplate'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ModifyWhitelistTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'PreCheckCreateOrderForDeleteDBNodes' => [
'summary' => 'Precheck for deleting a node and creating an order ',
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-wz9rziy3he051if82', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => 'The resource of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliwood-1688-mobile-promotion', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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\\\\\\"}\\"}', 'title' => ''],
],
[
'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\\"]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'PreCheckResult' => ['description' => 'The precheck result.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9B415BC6-FE84-5323-A255-42CF330DB99C', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Precheck for deleting an instance node ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckCreateOrderForDeleteDBNodes'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:PreCheckCreateOrderForDeleteDBNodes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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", 'title' => ''],
],
],
'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',
'title' => '',
],
'CurrentValue' => ['description' => 'The current value of the check item.'."\n", 'type' => 'string', 'example' => '15.0', 'title' => ''],
'Name' => ['description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'MajorVersion', 'title' => ''],
'RequiredValue' => ['description' => 'The value or value range that meets the requirements.'."\n", 'type' => 'string', 'example' => '17.0', 'title' => ''],
'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',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'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',
'title' => '',
],
],
'example' => '',
],
],
],
'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.', 'description' => ''],
['errorCode' => 'ReadonlyInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => 'The specified read-only instance does not support this operation.'],
['errorCode' => 'InvalidEngineVersion', 'errorMessage' => 'The specified EngineVersion is invalid.', 'description' => 'The specified EngineVersion parameter is invalid.'],
['errorCode' => 'MissingParameter.MinorVersionTag', 'errorMessage' => 'You must specify the parameter MinorVersionTag.', 'description' => 'The minor engine version cannot be left unspecified.'],
['errorCode' => 'Workbench.InternalFailure', 'errorMessage' => 'ECS workbench returns an internal failure. Please check password expiration policy and / or other issues.', 'description' => 'The ECS workbench API returned an internal error, with a high probability that the account password is incorrect. Please check whether the host account password has expired, and other possible circumstances.'],
['errorCode' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'errorMessage' => 'Current instance is already attached to another duckdb instance, operation is conflict.', 'description' => 'The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.'],
],
403 => [
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Read-only instance does not support this operation.', 'description' => 'This operation is not supported for read-only instances.'],
['errorCode' => 'DBInstanceStatusNotActive', 'errorMessage' => 'The status of the current instance is not active.', 'description' => 'The operation failed. Check the status of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'errorMessage' => 'Group Replication requires the instance engine version to be 8.0.', 'description' => ''],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
],
[
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => 'An internal error or exception has occurred.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:PrecheckDuckDBDependency',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'ConcurrentTaskExceeded', 'errorMessage' => 'Concurrent task exceeding the allowed amount.', 'description' => 'The number of concurrent tasks exceeds the maximum number of concurrent tasks that are allowed.'],
['errorCode' => 'IncorrectDBInstanceEngine', 'errorMessage' => 'Current DB Instance engine does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidPage.NotFound', 'errorMessage' => 'Page not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-09-01T02:53:10.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurgeDBInstanceLog'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:PurgeDBInstanceLog',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
'GmtCreated' => ['description' => 'The time when the notification was created.'."\n", 'type' => 'string', 'example' => '2022-04-21T02:04:04Z', 'title' => ''],
'GmtModified' => ['description' => 'The time when the notification was modified.'."\n", 'type' => 'string', 'example' => '2022-04-21T02:10:47Z', 'title' => ''],
'Id' => ['description' => 'The ID of the notification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '103499', 'title' => ''],
'IdempotentCount' => ['description' => 'The number of times that repeatedly sent notifications are blocked.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''],
'IdempotentId' => ['description' => 'This parameter ensures the idempotence of the notification and prevents the notification from being repeatedly sent.'."\n", 'type' => 'string', 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
'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', 'title' => ''],
'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****}', 'title' => ''],
'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', 'title' => ''],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageNumber' => ['description' => 'The page number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''],
'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '94CB8D93-017A-5AE7-A118-6E0F89D93C0A', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => 'A request parameter error occurred.'],
['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => 'The end time cannot be earlier than the start time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryNotify'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:QueryNotify',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryRecommendByCode' => [
'summary' => 'This API is used to query RDS bot hot spot questions. ',
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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"
.'}', 'title' => ''],
'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', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Query RDS Hot Spot Questions ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecommendByCode'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'rds:QueryRecommendByCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5xxxxxxx', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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' => '3298015', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '355DA57C-8CC4-40AB-B3F8-B684BA32EB9E', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '208676661', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'AtLeastThreeVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least three available IP addresses.', 'description' => 'The master switch requires at least 3 available IPs.'],
['errorCode' => 'AtLeastTwoVSwitchAvailableIp', 'errorMessage' => 'The primary vswitch requires at least two available IP addresses.', 'description' => 'The master switch requires at least 2 available IPs.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'No host is available for the requested instance.', 'description' => 'The specified zone does not have sufficient resources.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:RebuildDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'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****', 'title' => ''],
],
],
'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****', 'title' => ''],
'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****', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'test01', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildReplicationLink'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:RebuildReplicationLink',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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*****', 'title' => ''],
],
[
'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*****', 'title' => ''],
],
],
'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*****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFB6083A-7699-489B-8278-C0CB4793A96E', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GuardInstance.Exist', 'errorMessage' => 'The guard instance has exist.', 'description' => 'The disaster recovery instance already exists.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReceiveDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ReceiveDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'mssql.x4.medium.s1', 'title' => ''],
],
[
'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' => '40', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-bp18****', 'title' => ''],
],
[
'name' => 'TargetDBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the destination instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-bp17****', 'title' => ''],
],
[
'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' => 'test1,test2', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID of the new instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-****', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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.XX.XX.69', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'cloud_essd', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-bp1v****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '2270972****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E4CDD460-2618-51FE-BD0B-A1****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParameter', 'errorMessage' => 'illegal parameter, param is empty.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidRecoveryDbInstance.StorageSize', 'errorMessage' => 'The disk space of the new instance cannot be less than that of the current instance', 'description' => 'The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance.'],
['errorCode' => 'DBCountLimitExceeded', 'errorMessage' => 'Db count limit exceeded.', 'description' => 'The number of databases is exceeded.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'Forbidden.SnapshotRecovery', 'errorMessage' => 'Snapshot backup does not support partial restore', 'description' => 'The operation failed. Snapshot backup files cannot be used to restore only a specific part of data.'],
['errorCode' => 'StorageLimitExceeded', 'errorMessage' => 'Exceeding the allowed Storage of DB instance', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
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.', 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-20T06:08:27.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-09T03:04:00.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoveryDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:RecoveryDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'CurrentConnectionString',
'in' => 'query',
'schema' => ['description' => 'The public endpoint of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not existed.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T12:13:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstanceConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:ReleaseInstanceConnection',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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-uf6wjk5****.mysql.rds.aliyuncs.com', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Endpoint.NotFound', 'errorMessage' => 'Specified endpoint is not found.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'IncorrectDBSslStatus', 'errorMessage' => 'The link address has been used by SSL, modification and deletion are prohibited.', 'description' => '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.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T03:59:06.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:ReleaseInstancePublicConnection',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ReleaseReadWriteSplittingConnection' => [
'summary' => 'Use this operation to release a read/write splitting endpoint.',
'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 this ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'RWAddressType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'This parameter is not supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A77D650-27A1-4E08-AD9E-59008EDB6927', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A77D650-27A1-4E08-AD9E-59008EDB6927\\"\\n}","type":"json"}]',
'title' => 'ReleaseReadWriteSplittingConnection',
'description' => '### Supported engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS SQL Server'."\n"
."\n"
.'### Prerequisites'."\n"
."\n"
.'The API call fails if the instance does not meet the following requirements:'."\n"
."\n"
.'- The RDS MySQL instance uses a shared proxy.'."\n"
."\n"
.'- Read/write splitting is enabled.'."\n"
."\n"
.'- The instance must be one of the following versions:'."\n"
."\n"
.' - RDS MySQL 5.7 high availability edition (local SSD)'."\n"
."\n"
.' - RDS MySQL 5.6'."\n"
."\n"
.' - RDS SQL Server cluster edition',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-06-09T03:04:00.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseReadWriteSplittingConnection'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:ReleaseReadWriteSplittingConnection',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'proxyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the proxy mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'API', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'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"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-07-25T01:51:06.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-06-09T03:04:00.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTagsFromResource'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:RemoveTagsFromResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DatabaseInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '726702810223', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20181574543****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1AD222E9-E606-4A42-BF6D-8A4442913CEF ', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConcurrentOperate', 'errorMessage' => 'Concurrent operation is detected.', 'description' => 'Concurrent operations exist. Wait until the previous operation is complete and try again.'],
['errorCode' => 'ArrearageOrderExists', 'errorMessage' => 'Your account has an outstanding balance.', 'description' => 'Add funds to your Alibaba Cloud account, complete the overdue payments, and then try again.'],
['errorCode' => 'OperationDenied.MultiRegions', 'errorMessage' => 'Specified operation dose not support multiple regions.', 'description' => 'The current operation does 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The renewal expiration date cannot exceed:%s.', 'description' => 'The current instance is of the classic network type, and the renewal time cannot exceed the limit time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'StopService.Renew', 'errorMessage' => 'The service has been discontinued and renewal operations for instances on the classic network are no longer allowed.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot renew the instance.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', 'description' => 'The operation failed. ApsaraDB RDS supports two billing methods: subscription (Prepaid) and pay-as-you-go (Postpaid). Specify a valid billing method by using the PayType parameter.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-11-19T13:27:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-30T03:25:25.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-13T13:26:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-11T08:59:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-27T12:22:45.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-01-31T04:57:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:07.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:RenewInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'RenewRCInstance' => [
'summary' => 'This API is used to renew a subscription-based 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****', 'title' => ''],
],
[
'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_**', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-dh2jf9n6j4s14926****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Resource',
'in' => 'query',
'schema' => ['description' => 'The resources.'."\n", 'type' => 'string', 'required' => false, 'example' => 'buy', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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\\\\\\"}\\"}', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => '72329885****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The ID of the RDS Custom instance.'."\n", 'type' => 'string', 'example' => 'rc-dh2jf9n6j4s14926****'."\n", 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EFFC7565-B3CF-5CFA-9E1F-164DD1E1F498', 'title' => ''],
'OrderIds' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '23202700556****', 'title' => ''],
'OrderId' => ['type' => 'string', 'description' => 'The order ID.', 'example' => '23202700556****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'QueryPrice.Failed', 'errorMessage' => 'QueryPrice Failed.', 'description' => ''],
['errorCode' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL', 'errorMessage' => 'There are arrears orders.', 'description' => 'Your account has an overdue payment. Complete the payment and try again.'],
['errorCode' => 'InvalidEngine.VauleNotSupported', 'errorMessage' => 'The specified parameter "Engine" is not valid.', 'description' => 'The database engine is invalid. The database engine must be MySQL, SQL Server, PostgreSQL, or PPAS.'],
['errorCode' => 'InvalidEngineVersion.ValueNotSupported', 'errorMessage' => 'The specified parameter "EngineVersion" is not valid.', 'description' => 'The version of database engines version failed the verification check. Valid values:'."\n"
.'MySQL: 5.5, 5.6, and 5.7.'."\n"
.'SQL Server: 2008r2 and 2012.'."\n"
.'PostgreSQL: 9.4.'."\n"
.'PPAS: 9.3.'],
['errorCode' => 'InvalidDBInstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceClass" is not valid.', 'description' => 'The instance type of the RDS instance is invalid.'],
['errorCode' => 'InvalidDBInstanceStorage.ValueNotSupported', 'errorMessage' => 'The specified parameter "DBInstanceStorage" is not valid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceNetType.ValueNotSupported', 'errorMessage' => 'The specified parameter "InvalidDBInstanceNetType" is not valid.', 'description' => 'The operation failed. The network type is invalid. Check the network type. Standard SSDs and ESSDs support only the VPC network type.'],
['errorCode' => 'InvalidDBInstanceDescription.Malformed', 'errorMessage' => 'The specified parameter "DBInstanceDescription" is not valid.', 'description' => 'The instance description failed the verification check. The description must be 2 to 256 characters in length and can contain letters, underscores (_), and hyphens (-). The description must start with a letter and cannot start with http:// or https://.'],
['errorCode' => 'InvalidSecurityIPList.Malformed', 'errorMessage' => 'The specified parameter "SecurityIPList" is not valid.', 'description' => 'The IP address whitelist of the RDS instance is invalid.'],
['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'The Security IP address is not in the available range or occupied.', 'description' => 'The IP address is invalid. Specify a valid IP address.'],
['errorCode' => 'InvalidSecurityIPListLength.Malformed', 'errorMessage' => 'The quota of security ip exceeds.', 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist reaches the upper limit.'],
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'VswitchIpExhausted', 'errorMessage' => 'Vswitch IP exhausted.', 'description' => 'The operation failed. No vSwitch IP addresses are available.'],
['errorCode' => 'OperationDenied.InvalidStorageSize', 'errorMessage' => 'The storage size limit is exceeded.', 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => '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.', 'description' => '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.', 'description' => '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.', 'description' => 'No payment method has been 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.', 'description' => 'You currently have outstanding bills, please settle them first.'],
['errorCode' => 'InvalidParam.UsedTime', 'errorMessage' => 'The renewal expiration date cannot exceed:%s.', 'description' => 'The current instance is of the classic network type, and the renewal time cannot exceed the limit time.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => '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.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot renew the instance.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
],
403 => [
['errorCode' => 'InvalidEngineVersionInRegion.NotAvailable', 'errorMessage' => 'The EngineVersion in the Region is not available.', 'description' => 'The database engine version is not supported in the region.'],
['errorCode' => 'InvaildEngineInRegion.NotAvailable', 'errorMessage' => 'The Engine in the Region is not available.', 'description' => 'The database engine is not supported in the region.'],
['errorCode' => 'OperationDenied', 'errorMessage' => 'The resource is out of usage.', 'description' => 'Insufficient resources. Contact on-duty engineers to increase the inventory.'],
['errorCode' => 'RegionUnauthorized', 'errorMessage' => 'There is no authority to create instance in the specified region.', 'description' => 'RDS instances cannot create in this region. Specify a different region and try again.'],
['errorCode' => 'QuotaExceeded.CreateInstance', 'errorMessage' => 'The quota of create instance exceeds.', 'description' => 'The maximum number of instances has been exceeded. Release the instances that are no longer needed.'],
['errorCode' => 'Forbidden.Authentication', 'errorMessage' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'description' => ''],
['errorCode' => 'INST_HAS_UNPAID_ORDER', 'errorMessage' => 'The instanceId has unpaid order.', 'description' => 'You have an unpaid order for the instance. Pay for or cancel the order and try again.'],
['errorCode' => 'COMMODITY.FAILED', 'errorMessage' => 'The commodity is error.', 'description' => 'A server error occurred. Contact O&M engineers.'],
['errorCode' => 'MoneyLessThan100', 'errorMessage' => 'The Account Monet less Than 100.', 'description' => 'Your account balance is insufficient. Add funds to your account.'],
['errorCode' => 'InvalidOrderCharge.NotPay', 'errorMessage' => 'The specified parameter OrderCharge is not pay.', 'description' => 'You have unpaid orders for the RDS instance. Complete or cancel the orders and try again.'],
['errorCode' => 'OperationDenied.NotSupportedBackupMethod', 'errorMessage' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidRegionId.NotFound', 'errorMessage' => 'The provided RegionId does not exist.', 'description' => 'The specified region ID is not found. Please check again.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The provided InstanceId does not exist.', 'description' => 'The RDS instance cannot be found. Check that the RDS instance is created within the logged-on account and is not deleted.'],
['errorCode' => 'canNotFindSubscription', 'errorMessage' => 'Subscription information not found.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'Specified order charge does not support in RDS.', 'description' => 'The operation failed. RDS supports Prepaid (subscription) and Postpaid (pay-as-you-go) billing methods. Please set the correct instance PayType (payment type).'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => 'Renew an RDS Custom Instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:RenewRCInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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, 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-m5ei7b1w38w2l91x****', 'docRequired' => true, 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'IsLocalDisk',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'None', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Abs.ImageNotFound', 'errorMessage' => 'The specified Image is disabled or is deleted.', 'description' => 'The specified image has expired or has been deleted.'],
['errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', 'description' => ''],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameter is not valid', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'OperationDenied', 'errorMessage' => 'The specified image contains the snapshot of the data disk,does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => 'The specified ImageId does not exist.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
['errorCode' => 'InvalidHostStatus.Format', 'errorMessage' => 'Specified host status is not valid.', 'description' => ''],
['errorCode' => 'ReplaceSystemDisk.InvalidImageId', 'errorMessage' => 'The paid image only replace instance systemDisk using the original image.', 'description' => 'Paid mirroring can only be used to reinstall the original system.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstance', 'errorMessage' => 'The current DB instance does not support this operation.', 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:ReplaceRCInstanceSystemDisk',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the privileged account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', 'description' => 'Failed to update the account. Check the specified parameters or the parameter policy configuration.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccount'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ResetAccount',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ResetAccountPassword' => [
'summary' => 'Resets the password of a database account.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'GdnRole.NotSupport', 'errorMessage' => 'Specified gdn role is not support.', 'description' => ''],
['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => 'The password of the account is invalid. Specify a valid password.'],
['errorCode' => 'IncorrectAccountStatus', 'errorMessage' => 'Current account status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'DbossGeneralError', 'errorMessage' => 'The instance is being created. Please wait.', 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['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).', 'description' => '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.', 'description' => 'This account is managed by the Supabase and cannot be modified directly. Use the RDS Supabase console or API to modify.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectAccountType', 'errorMessage' => 'Current account type does not support this operation.', 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'IncorrectAccountPrivilegeType', 'errorMessage' => 'the current account privilege type does not support this operation.', 'description' => 'The permission type of the current account does not support this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-05-12T02:14:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-03-31T08:25:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-19T09:51:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-24T06:10:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-02-22T13:02:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ResetAccountPassword',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'operationType' => 'readAndWrite',
],
'ResizeRCInstanceDisk' => [
'summary' => 'ResizeRCInstanceDisk',
'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, 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rm-uf62br2491p5l****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'NewSize',
'in' => 'query',
'schema' => ['description' => 'The new disk size. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'docRequired' => true, 'title' => ''],
],
[
'name' => 'DiskId',
'in' => 'query',
'schema' => ['description' => 'The disk ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'rcd-x4462840nwinu6rr61m5o', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '230546833080102', 'title' => ''],
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CallEcsApi.Failure', 'errorMessage' => 'Fail to call ECS API.', 'description' => 'Failed to call the ECS api.'],
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidStorageSize.Direction', 'errorMessage' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', 'description' => 'The storage space does not meet the constraint requirements of the current change direction.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => 'No credit card is available.'],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Required parameters are missing.'],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => 'The instance status does not support this operation.'],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidDiskSize.TooSmall', 'errorMessage' => 'Specified new disk size is less than the original disk size.', 'description' => 'The new disk specified is smaller than the original disk.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => 'The KMS key is disabled.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'Invalid DBInstanceId NotFound.', 'description' => 'The instance ID cannot be found.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => 'The specified host information does not exist.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Scale out the storage space of an RDS Custom instance',
'description' => 'Local disk instances do not support changing storage space.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:ResizeRCInstanceDisk',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'CustomDisk', 'arn' => 'acs:rds:{#regionId}:{#accountId}:customdisk/{#DiskId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 230546833080102,\\n \\"RequestId\\": \\"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC\\"\\n}","type":"json"}]',
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', 'description' => 'A switchover for high availability is in progress. Please wait.'],
['errorCode' => 'InvalidDBInstanceStatus.NotSupport', 'errorMessage' => 'The Specified instance status is not supported to restart instance.', 'description' => ''],
['errorCode' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'errorMessage' => 'SpecialTime is not valid.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidDBInstanceName.Format', 'errorMessage' => 'Specified DB instance name is not valid.', 'description' => 'The instance does not exist. Check the instance information.'],
['errorCode' => 'MGRMasterNodeRestart.Unsupported', 'errorMessage' => 'Specific primary node is not supported to restart in MGR instance.', 'description' => 'The MGR instance cannot specify a primary restart.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectRestartMethod', 'errorMessage' => 'The specified RestartMethod params is not valid.', 'description' => ''],
['errorCode' => 'IncorrectEffectiveTime', 'errorMessage' => 'The specified EffectiveTime params is not valid.', 'description' => 'The value of the EffectiveTime parameter is invalid.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceCharacterType', 'errorMessage' => 'Current DB Instance character_type does not support this operation.', 'description' => 'This operation is not supported for the character type of the current instance.'],
['errorCode' => 'InvalidRestartPolicy.Format', 'errorMessage' => 'Specified Restart Policy is not valid.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidNodeId.NotFound', 'errorMessage' => 'The target node does not exist in the current instance.', 'description' => 'The target node does not exist in the current instance.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-31T08:25:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-10-11T13:44:47.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-07-13T09:35:02.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-10-28T02:18:38.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-07-08T08:17:25.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:RestartDBInstance',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-bp****', 'title' => ''],
],
[
'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"}]}]', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '75BBF1EF-1E90-4950-BFFB-252D26E8259B', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', 'description' => ''],
['errorCode' => 'InvalidParamTableMetaForRestore.Content', 'errorMessage' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta', 'errorMessage' => 'Invalid parameter TableMeta is null or not json format', 'description' => 'The value of the TableMeta parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidBakHistoryDO', 'errorMessage' => 'BakHistory is inbalid when check restore TableMeta', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta.Content', 'errorMessage' => 'TableMeta missing old dbname or new dbname, please check', 'description' => 'The value of the table_meta parameter does not contain the names of the source and destination tables.'],
['errorCode' => 'InvalidParamTableMeta.Duplicate', 'errorMessage' => 'TableMeta has duplicate db or table with other newname, commons or system', 'description' => 'The operation failed. The databases and tables that you want to restore already exist in the RDS instance.'],
['errorCode' => 'InvalidSourceRestoreDBName.NotFound', 'errorMessage' => 'specific source restore dbname is not found in db list', 'description' => 'The operation failed. The data backup file does not contain the data of the databases.'],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', 'description' => 'The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.'],
['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'The user ID cannot be found.'],
['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'The operation failed. The UID in the request is left unspecified.'],
['errorCode' => 'NoAvailableDisasterRestoreBakset', 'errorMessage' => 'No available disaster restore bakset.', 'description' => 'No available restore set is found.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', 'description' => 'The read-only instance already exists.'],
['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', 'description' => 'The operation failed. The data backup file does not support the restoration of individual databases and tables.'],
['errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', 'description' => 'The operation failed. The data backup file is not in a ready state.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'RestoreType.NotFound', 'errorMessage' => 'RestoreType is not found.', 'description' => 'RestoreType is not found.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => ''],
['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => ''],
['errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', 'description' => 'The binary log file at the specified point in time is invalid.'],
['errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-03T14:38:31.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreDdrTable'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:RestoreDdrTable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'RestoreTable' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'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 generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'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.', 'type' => 'string', 'required' => false, 'example' => '902****', 'title' => ''],
],
[
'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"
.'>'."\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', 'title' => ''],
],
[
'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"
."\n"
.'- ApsaraDB RDS for PostgreSQL: `[{"type":"db","name":"","newname":""}]`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]', 'title' => ''],
],
[
'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"
."\n"
.'- **false**: disables the feature.'."\n"
."\n"
.'> For more information, see [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EA2D4F34-01A7-46EB-A339-D80882135206', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRestoreType.Format', 'errorMessage' => 'Specified restore type is not valid.', 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['errorCode' => 'InvalidBakset.Invalid', 'errorMessage' => 'Specified bakset is not valid.', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta', 'errorMessage' => 'Invalid parameter TableMeta is null or not json format', 'description' => 'The value of the TableMeta parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidBakHistoryDO', 'errorMessage' => 'BakHistory is inbalid when check restore TableMeta', 'description' => ''],
['errorCode' => 'InvalidBakTableMetaDO', 'errorMessage' => 'BakTableMeta in BakHistory.Info is invalid', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta.Content', 'errorMessage' => 'TableMeta has duplicate db.table in newname or with common.', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta.Duplicate', 'errorMessage' => 'TableMeta has duplicate db or table with other newname, commons or system', 'description' => 'The operation failed. The databases and tables that you want to restore already exist in the RDS instance.'],
['errorCode' => 'InvalidSourceRestoreDBName.NotFound', 'errorMessage' => 'specific source restore dbname is not found in db list', 'description' => 'The operation failed. The data backup file does not contain the data of the databases.'],
['errorCode' => 'InvalidParamTableMetaForRestore.Content', 'errorMessage' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance', 'description' => ''],
['errorCode' => 'InvalidDBName.Duplicate', 'errorMessage' => 'Specified DB name already exists in the This instance.', 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'InvalidAvZone.Format', 'errorMessage' => 'Specified AvZone is not valid.', 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The region ID is invalid. Check the region ID.'],
['errorCode' => 'InvalidIP.Format', 'errorMessage' => 'Specified ip is not valid.', 'description' => ''],
['errorCode' => 'InvalidVpcParameter', 'errorMessage' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', 'description' => 'The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.'],
['errorCode' => 'MissingUserID', 'errorMessage' => 'The request is missing a user_id parameter.', 'description' => 'The user ID cannot be found.'],
['errorCode' => 'MissingUID', 'errorMessage' => 'The request is missing a uid parameter.', 'description' => 'The operation failed. The UID in the request is left unspecified.'],
['errorCode' => 'MissBackupSetAndRestoreTime.NotFound', 'errorMessage' => 'Both BackupSet and RestoreTime are null.', 'description' => 'The operation failed. The BackupSet parameter and the RestoreTime parameter are left unspecified.'],
['errorCode' => 'InvalidBakHistory.DbVersionMismatch', 'errorMessage' => 'db version of bakhistory is mismatch with custins', 'description' => 'For database and table restoration, the new instance must run the same engine version as the original instance.'],
['errorCode' => 'DiskSize.NotEnough', 'errorMessage' => 'The disk size is not enough to restore tables.', 'description' => ''],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is not supported for this function.', 'description' => ''],
['errorCode' => 'RestoreTableException', 'errorMessage' => 'RestoreTable Exception, result is null.', 'description' => ''],
['errorCode' => 'InvalidParamTableMeta.TooManyTables', 'errorMessage' => 'At most 100 tables are supported. Restoring the database is recommended.', 'description' => ''],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Current backup log enable status does not support this operation.', 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectBackupSetMethod', 'errorMessage' => 'Current backup set method does not support operations.', 'description' => 'The operation failed. The data backup file does not support the restoration of individual databases and tables.'],
['errorCode' => 'IncorrectBackupSetState', 'errorMessage' => 'Current backup set state does not support operations.', 'description' => 'The operation failed. The data backup file is not in a ready state.'],
['errorCode' => 'ChildDBInstanceExists', 'errorMessage' => 'Current DB instance had child instance.', 'description' => 'The read-only instance already exists.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'InvalidMeta.TooLarge', 'errorMessage' => 'Meta information is too large.', 'description' => 'The metadata information is too large. Check whether the number of instance tables exceeds 50000.'],
],
[
['errorCode' => 'InvalidBackup.NotFound', 'errorMessage' => 'The available backup does not exist in recovery time.', 'description' => ''],
['errorCode' => 'InvalidBinlog.NotFound', 'errorMessage' => 'The available binlog does not exist in recovery time.', 'description' => 'The binary log file at the specified point in time is invalid.'],
['errorCode' => 'InvalidBackupSetID.NotFound', 'errorMessage' => 'Specified backup set ID does not exist.', 'description' => 'The backup set does not exist. Specify an available backup set.'],
['errorCode' => 'InvalidDB.NotFound', 'errorMessage' => 'Specified db does not exist or DB status does not support.', 'description' => ''],
['errorCode' => 'InvalidRegion.NotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', 'description' => ''],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested instance.', 'description' => ''],
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', 'description' => ''],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'RestoreTable',
'summary' => 'Restores individual databases or tables of an instance to the original instance.',
'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"
.'- [Restore individual databases and tables of an ApsaraDB RDS for MySQL instance](~~103175~~)'."\n"
."\n"
.'- [Restore individual databases and tables of an ApsaraDB RDS for PostgreSQL instance](~~613672~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-10-09T05:04:48.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-26T05:59:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-20T02:31:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-18T05:44:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-31T11:33:34.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-01-10T09:48:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-01-10T09:48:16.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreTable'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:RestoreTable',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EA2D4F34-01A7-46EB-A339-D80882135206\\"\\n}","type":"json"}]',
],
'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-uf6wjk5****', 'title' => ''],
],
[
'name' => 'AccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => '%s', 'errorMessage' => 'DB Operation Failed:%s.', 'description' => ''],
['errorCode' => 'Account.UpdateError', 'errorMessage' => 'Update Account failed, please check your input value', 'description' => 'Failed to update the account. Check the specified parameters or the parameter policy configuration.'],
['errorCode' => 'Database.ConnectError', 'errorMessage' => 'Database connect error. please check instance status and database processlist', 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['errorCode' => 'DbRestoring', 'errorMessage' => 'Database is in restoring state.', 'description' => 'The database is in the restoring state.'],
['errorCode' => 'SqlExcutionFailed', 'errorMessage' => 'Database is in transition. Try the statement later.', 'description' => 'The database is being modified. Try again later.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidCharacter.DbOrAccount', 'errorMessage' => 'The database name or account name contains invalid characters.', 'description' => 'The database name or account name contains illegal characters.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T02:40:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-28T04:15:29.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-06T01:57:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-03-28T12:12:49.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeAccountPrivilege'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:RevokeAccountPrivilege',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2023-06-09T03:04:00.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeOperatorPermission'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:RevokeOperatorPermission',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'RunRCInstances' => [
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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' => 'Month',
'default' => 'Month',
'enum' => ['Month', 'Year'],
'title' => '',
],
],
[
'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' => 'true', 'default' => 'true', 'title' => ''],
],
[
'name' => 'SecurityEnhancementStrategy',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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****', 'title' => ''],
],
[
'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' => 'TestRDS123!', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'AutoUseCoupon',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically use a coupon. Valid values:'."\n"
.'* **true** (default): Yes.'."\n"
.'* **false**: No.'."\n"
."\n"
.'> If you use a coupon and later decrease the quota, the amount offset by the coupon will not be refunded.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['description' => 'The coupon code. ', 'type' => 'string', 'required' => false, 'example' => '72329885****', 'title' => ''],
],
[
'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' => 'cloud_essd', 'default' => 'cloud_essd', 'title' => ''],
'DeleteWithInstance' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'null', 'title' => ''],
'Encrypted' => ['description' => 'Specifies whether to encrypt the cloud disk. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
'PerformanceLevel' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PL1', 'title' => ''],
'Size' => ['description' => 'The size of the data disk. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
'SnapshotId' => ['description' => 'The snapshot used to create the data disk.'."\n"
."\n"
.'- If the snapshot size corresponding to **DataDisk.SnapshotId** is greater than the value of **DataDisk.Size**, the created disk size matches the snapshot size. If the snapshot size is smaller than the value of **DataDisk.Size**, the created disk size equals the value of **DataDisk.Size**.'."\n"
.'- Creating an elastic ephemeral disk from a snapshot is not supported.'."\n"
.'- Snapshots created on or before July 15, 2013 cannot be used to create disks.', 'type' => 'string', 'required' => false, 'example' => 's-bp17441ohwka0yuh****', 'title' => ''],
'Device' => ['description' => 'The mount target of the data disk.'."\n"
."\n"
.'> This parameter is used only in the full image (entire machine image) scenario. You can set this parameter to the mount target of the data disk in the full image and modify the corresponding **DataDisk.Size** and **DataDisk.Category** parameters to change the disk category and size of the data disk in the full image.', 'type' => 'string', 'required' => false, 'example' => '/dev/xvdb', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rc-node-[99,1]-rchost', 'title' => ''],
],
[
'name' => 'DeploymentSetId',
'in' => 'query',
'schema' => ['description' => 'The deployment set ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ds-uf6670sipmph********', 'title' => ''],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'InternetMaxBandwidthOut',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'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-uf6av412xaxixu******', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'IoOptimized',
'in' => 'query',
'schema' => ['description' => 'The reserved parameter. This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => 'The ID of the image used by the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'image-dsvjzw2ii8n4******', 'title' => ''],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
'PerformanceLevel' => ['description' => 'Performance level when the system disk is an enterprise SSD (ESSD). For details about performance differences among ESSD types, see [enterprise SSD (ESSD)](~~2859916~~). Valid values: '."\n"
."\n"
.'- **PL0** '."\n"
.'- **PL1** (default) '."\n"
.'- **PL2** '."\n"
.'- **PL3** ', 'type' => 'string', 'required' => false, 'example' => 'PL1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'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', 'title' => ''],
],
[
'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' => 'true', 'default' => 'true', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'maxItems' => 21,
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can create up to N tag keys at the same time, where N ranges from **1 to 20**. Empty strings are not allowed.', 'type' => 'string', 'required' => false, 'example' => 'Testkey1', 'title' => ''],
'Value' => ['description' => 'The tag value corresponding to the tag key. You can create up to N tag values at the same time, where N ranges from **1 to 20**. Empty strings are allowed.', 'type' => 'string', 'required' => false, 'example' => 'Testvalue1', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID. ', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
[
'name' => 'CreateMode',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the instance can be added to an ACK cluster. When this parameter is set to **1**, the created instance can be added to an ACK cluster by invoking the **AttachRCInstances** API operation, enabling efficient management of container applications.'."\n"
."\n"
.'- **1**: Yes.'."\n"
.'- **0** (default): No.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'HostName',
'in' => 'query',
'schema' => ['description' => 'Hostname of the instance (2–64 characters). '."\n"
."\n"
.'- Multiple segments separated by periods (.) are supported. Each segment can contain uppercase and lowercase English letters, digits, and hyphens (-). '."\n"
.'- A period (.) or hyphen (-) cannot appear at the beginning or end of a segment, nor can two periods or hyphens appear consecutively.', 'type' => 'string', 'required' => false, 'example' => 'testHost1', 'title' => ''],
],
[
'name' => 'SpotStrategy',
'in' => 'query',
'schema' => ['description' => 'The spot strategy for pay-as-you-go instances. This parameter takes effect only when the **InstanceChargeType** parameter is set to **PostPaid**. Valid values: '."\n"
."\n"
.'- **NoSpot**: Normal pay-as-you-go instance. '."\n"
.'- **SpotAsPriceGo**: The system automatically bids based on the current market price. '."\n"
."\n"
.'Default value: **NoSpot**. ', 'type' => 'string', 'required' => false, 'example' => 'NoSpot', 'title' => ''],
],
[
'name' => 'SupportCase',
'in' => 'query',
'schema' => ['description' => 'The deployment type of RDS Custom. Valid values:'."\n"
."\n"
.'- **eni**: Dual network interface cards.'."\n"
.'- **edge**: Point of presence (POP) node pool.'."\n"
.'- **share**: VPC.', 'type' => 'string', 'required' => false, 'example' => 'share', 'title' => ''],
],
[
'name' => 'CreateExtraParam',
'in' => 'query',
'schema' => ['description' => 'Reserved parameter. Not supported currently. ', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''],
],
[
'name' => 'CreateAckEdgeParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Information about the ACK Edge cluster.',
'type' => 'object',
'properties' => [
'ClusterId' => ['description' => 'The ID of the target ACK Edge cluster.', 'type' => 'string', 'required' => false, 'example' => 'c463aaa89e2b84cacacfbf23c4867****', 'title' => ''],
'NodePoolId' => ['description' => 'The ID of the target edge node pool in the ACK Edge cluster.', 'type' => 'string', 'required' => false, 'example' => 'np47e018268fb34e2289ff4c4d22b5****', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'UserData',
'in' => 'query',
'schema' => ['description' => 'The instance user data. The raw data can be up to 32 KB in size. '."\n"
."\n"
.'Do not pass sensitive information, such as passwords and private keys, in plaintext. If you must pass such information, encrypt it first, encode it in Base64, and then transmit it. Decrypt and use it inside the instance. The following is an example of converting a script into a Base64-encoded string: '."\n"
."\n"
.'```'."\n"
.'echo -n \'#!/bin/sh'."\n"
.'echo "Hello World"\' | base64 -w 0'."\n"
.'``` ', 'type' => 'string', 'required' => false, 'example' => 'IyEvYmluL3NoCmVjaG8gIkhlbGxvIFdvcmxkLiBUaGUgdGltZSBpcyBub3cgJChkYXRlIC1SKSIhIHwgdGVlIC9yb290L3VzZXJkYXRhX3Rlc3QudHh0', 'title' => ''],
],
[
'name' => 'UserDataInBase64',
'in' => 'query',
'schema' => ['description' => 'Specifies whether custom data is Base64-encoded. '."\n"
."\n"
.'- **true**: Yes. '."\n"
.'- **false** (default): No. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DeletionProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable release protection. Valid values: '."\n"
.'* **true**: Enabled '."\n"
.'* **false** (default): Disabled ', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ScheduledRule',
'in' => 'query',
'schema' => ['description' => 'Scheduled elasticity rule', 'title' => '', 'type' => 'string', 'example' => '{"rule":[{"beginTime":"09:00","endTime":"17:00","acu":4}]}', 'required' => false],
],
[
'name' => 'AcuType',
'in' => 'query',
'schema' => ['description' => 'ACU type', 'title' => '', 'type' => 'string', 'example' => 'gn8is', 'required' => false],
],
[
'name' => 'PrivateIpAddress',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => '10.1.**.**', 'description' => '', 'title' => ''],
],
[
'name' => 'SecurityGroupIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'sg-bp15ed6xe1yxeycg7****', 'description' => '', 'title' => ''],
'maxItems' => 10,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'PasswordInherit',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use the password preset in the image. When this parameter is used, the Password parameter must be empty, and you must ensure that the selected image has a password already configured. Default value: false. ', 'title' => '', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => ''],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'NetworkOptions',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'object',
'properties' => [
'EnableJumboFrame' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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****\']}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '237850846720798', 'title' => ''],
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '535BD857-E88F-5B4F-A18C-FAF59A74741F'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUserAccount.NotSupported', 'errorMessage' => 'the Specified user account Validated not supported.', 'description' => 'the Specified user account Validated not supported.'],
['errorCode' => 'InvalidInstanceType.NotSupportDiskCategory', 'errorMessage' => 'The instanceType of the specified instance does not support this disk category.', 'description' => 'The instanceType of the specified instance does not support this disk category.'],
['errorCode' => 'InvalidInstanceType.ZoneNotSupported', 'errorMessage' => 'The specified zone does not support this instancetype.', 'description' => 'The specified zone does not support this instancetype.'],
['errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified instance type is not supported.', 'description' => 'The specified instance type is not supported.'],
['errorCode' => 'InvalidImageId.NotFound', 'errorMessage' => 'The specified ImageId does not exist.', 'description' => 'The specified ImageId does not exist.'],
['errorCode' => 'InsufficientCapacity', 'errorMessage' => 'There is insufficient capacity available for the requested resource.', 'description' => 'Insufficient resources. Please try again later.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidPayType.NotSupported', 'errorMessage' => 'current instance pay type not support this operation.', 'description' => 'The payment type of the current instance does not support this operation.'],
['errorCode' => 'InvalidTargetDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The specified database instance name does not exist.'],
['errorCode' => 'InvalidParameters.ImageId', 'errorMessage' => 'The specified image does not support the specified InstanceType.', 'description' => ''],
['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.', 'description' => 'The specified DataDisk.n.Size is outside the allowed range, or the capacity of the snapshot exceeds the size limit for the specified disk category.'],
['errorCode' => 'InvalidParameters.SystemSize', 'errorMessage' => 'SystemDisk size is invalid.', 'description' => 'The system disk size is invalid.'],
['errorCode' => 'InvalidHostName.CustomMalformed', 'errorMessage' => 'Customized section of host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].', 'description' => 'The custom part of the hostname is invalid, please use a valid format:[], [,], [m,], [, n], [m, n].'],
['errorCode' => 'InvalidParameters.SecurityGroupIds', 'errorMessage' => 'The SecurityGroupIds is not valid.', 'description' => 'An invalid security group exists in the security group list.'],
['errorCode' => 'InvalidSecurityGroupId.SingleIdAndMultiIdConflict', 'errorMessage' => 'The specified parameter not support to set SecurityGroupId and SecurityGroupIds at the same time.', 'description' => 'The security group and security group list cannot be set at the same time.'],
['errorCode' => 'InvalidSecurityGroupId.DuplicateId', 'errorMessage' => 'The specified parameter SecurityGroupIds has duplicateId.', 'description' => 'The specified security group list has duplicate'],
['errorCode' => 'EnterpriseGroupLimited.MutliGroupType', 'errorMessage' => 'The specified instance can not join multi SecurityGroup types.', 'description' => 'The specified instance cannot be added to both a common security group and an enterprise security group.'],
['errorCode' => 'InvalidDescription.Malformed', 'errorMessage' => 'The specified parameter "Description" is not valid.', 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['errorCode' => 'InvalidPrivateIpAddress.MultipleInstancesNotSupported', 'errorMessage' => 'Specifying private IP address for multiple instances is not supported.', 'description' => 'The specified private IP address does not support creating multiple instances.'],
['errorCode' => 'InvalidParameters.DataDisk', 'errorMessage' => 'the data disk size is less than dataDiskSnapshotsSize.', 'description' => 'The size of the purchased data disk is not larger than the snapshot size of the data disk that supports mirroring.'],
['errorCode' => 'InvalidUserData.Base64FormatInvalid', 'errorMessage' => 'The specified UserData is not base64 encoded.', 'description' => 'The specified UserData is not base64 encoded'],
['errorCode' => 'InvalidUserData.NotSupported', 'errorMessage' => 'The specified GPU instanceType is not supported the use of userdata.', 'description' => 'The specified GPU specification does not support the use of user-defined data'],
['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The Tag.N.Value parameter is invalid.', 'description' => 'The Tag.N.Value parameter is invalid.'],
['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => 'The number of tags exceeds 20.'],
['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', 'description' => 'The values of two Tag.N.Key parameters are duplicate.'],
['errorCode' => 'InvalidDescription.CustomMalformed', 'errorMessage' => 'Customized section of host description is invalid, please use valid format.', 'description' => 'The custom instance description is illegal.'],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'InstanceId is invalid, not found.', 'description' => 'Invalid InstanceId, no valid instance data found'],
['errorCode' => 'InvalidParameters', 'errorMessage' => 'Invalid createMode or supportCase.', 'description' => 'createMode or supportCase illegal.'],
['errorCode' => 'InvalidParam.DefaultVpcNotSupport', 'errorMessage' => 'Default vpc is not supported.', 'description' => 'The default VPC is not supported.'],
['errorCode' => 'InvalidPerformanceLevel.Malformed', 'errorMessage' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', 'description' => 'The parameter PerformanceLevel of the specified data disk is invalid.'],
['errorCode' => 'InvalidSystemDiskCategory.ValueNotSupported', 'errorMessage' => 'The current operation does not support this system disk type.', 'description' => 'The current operation does not support this system disk type.'],
['errorCode' => 'InvalidParameter.DataDiskNotSupported', 'errorMessage' => 'DataDisk is not supported for vNode.', 'description' => 'Container nodes temporarily do not support data disks.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => 'The values of some parameters are invalid.'],
['errorCode' => 'QuotaExceed.ElasticQuota', 'errorMessage' => '%s.', 'description' => 'The ECS usage of the host corresponding to the Custom instance exceeds the quota limit, please go to the Aliyun official website console to apply for increasing the quota.'],
['errorCode' => 'InvalidInstanceName.CustomMalformed', 'errorMessage' => 'The instance name is invalid, please use valid format.', 'description' => 'Instance name format does not conform to specification'],
['errorCode' => 'InvalidParameter.ScheduledRule', 'errorMessage' => 'The specified parameter ScheduledRule is not valid.', 'description' => 'Parameter ScheduledRule is incorrect, please re-enter'],
['errorCode' => 'InvalidParam.AcuType', 'errorMessage' => 'The parameter AcuType is invalid, please check and re-enter.', 'description' => 'The parameter acuType is illegal, please check and re-enter.'],
['errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', 'description' => 'The resource group ID cannot be found. Check the resource group ID.'],
['errorCode' => 'InvalidDisk.CategoryFormat', 'errorMessage' => 'The specified eed category does not support this operation.', 'description' => 'Elastic temporary disk does not support this operation'],
['errorCode' => 'InvalidEEDDisk.NotSupport', 'errorMessage' => 'The specified eed category does not support this operation.', 'description' => 'Flexible temporary disk does not support this operation'],
['errorCode' => 'InvalidPrivateIpAddress.AlreadyUsed', 'errorMessage' => 'The specified IP is already used.', 'description' => 'The IP address has been used.'],
['errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', 'description' => 'The VPC endpoint is invalid.'],
['errorCode' => 'InvalidSnapshot.Malformed', 'errorMessage' => 'The specified eed category does not support snapshot operation.', 'description' => 'Elastic temporary disks do not support snapshot recovery or snapshot creation.'],
['errorCode' => 'InvalidEEDDisk.DeleteWithInstanceConflict', 'errorMessage' => 'The specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute false.', 'description' => 'Elastic temporary disk needs to be released with instance release'],
['errorCode' => 'OperationDenied.InvalidClusterStatus', 'errorMessage' => 'The specified cluster status not support current operation.', 'description' => 'The specified cluster status not support current operation.'],
['errorCode' => 'InvalidParam.ClusterIdNotExist', 'errorMessage' => 'The specified cluster does not exist.', 'description' => 'The cluster passed in by the user does not exist.'],
['errorCode' => 'InvalidParam.NotSupportJumboFrame', 'errorMessage' => 'Not support jumbo frame.', 'description' => 'The current specification does not support jumbo frames.'],
['errorCode' => 'InvalidHostName.Malformed', 'errorMessage' => 'The specified parameter HostName is not valid.', 'description' => 'The specified host name is illegal'],
['errorCode' => 'Order.UserCannotBuyCloudCommodity', 'errorMessage' => 'Missing the "Group Cloud Adoption" product tag. Purchase is disabled. For internal group scenarios, we recommend purchasing Subscription products.', 'description' => 'Missing the "Group Cloud Adoption" product tag. Purchase is disabled. For internal group scenarios, we recommend purchasing Subscription products.'],
['errorCode' => 'OperationDenied.ZoneIsDisabled', 'errorMessage' => 'The specified zone is disabled. You cannot create a vSwitch in a disabled zone.', 'description' => 'The current zone is disabled and you are not allowed to create a VSwitch.'],
['errorCode' => 'InvalidDisk.SystemDiskSize', 'errorMessage' => 'The specified SystemDiskSize beyond the permitted range.', 'description' => 'The system disk size exceeds the maximum allowable value.'],
['errorCode' => 'UnNativeEcs.CanNotCreateByShareSwitch', 'errorMessage' => 'The Specified unNative ecs can not create by share switch.', 'description' => 'This non-dual NIC instance cannot be created through a shared switch'],
['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The VPC ID cannot be found. Check the VPC ID.'],
['errorCode' => 'InvalidClientToken.ValueNotSupported', 'errorMessage' => 'The ClientToken provided is invalid.', 'description' => 'The specified ClientToken is illegal.'],
['errorCode' => 'IncorrectStatus.VpcPeer', 'errorMessage' => 'The specified resource of VpcPeer status is invalid.', 'description' => 'The vpc peer-to-peer connection between the vpc instance to which the switch belongs and the resource account is currently not activated.'],
['errorCode' => 'ResourceNotFound.VpcPeer', 'errorMessage' => 'The specified resource of VpcPeer is not found.', 'description' => 'The vpc instance to which the VSwitch belongs in the request parameter has not established a vpc peer-to-peer connection with the resource account.'],
],
403 => [
['errorCode' => 'InvalidSecurityGroupId.NotFound', 'errorMessage' => 'The specified SecurityGroupId does not found.', 'description' => 'The security group that is specified by the SecurityGroupId parameter cannot be found. The security group and the RDS instance do not belong to the same region.'],
['errorCode' => 'InvalidInstanceType.NotSupported', 'errorMessage' => 'The specified InstanceType is not Supported.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'QuotaExceed.DeploymentSetInstanceQuotaFull', 'errorMessage' => 'The instance quota in one deployment set exceeded.', 'description' => ''],
['errorCode' => 'InvalidDiskCategory.NotSupported', 'errorMessage' => 'The specified disk category is not support the specified instance type.', 'description' => ''],
['errorCode' => 'OperationDenied.InvalidCluster', 'errorMessage' => 'The operation is not allowed for the cluster, please check clusterId and createExtraParam.', 'description' => 'The cluster information passed in is incorrect. Check the parameters.'],
['errorCode' => 'InvalidParam.DataDisKSizeInvalid', 'errorMessage' => 'The specified cloud disk size is invalid.', 'description' => 'The size of the disk does not match the type. Please insure the size of the cloud disk is within the supported range.'],
['errorCode' => 'InstanceDiskNumLimitExceed', 'errorMessage' => 'The number of specified disk in an instance exceeds.', 'description' => ''],
['errorCode' => 'OperationDenied.PerformanceLevelNotMatch', 'errorMessage' => 'The specified PerformanceLevel and disk size do not match.', 'description' => 'The specified performance level does not match the disk size.'],
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Arguments on this idempotent request are inconsistent with arguments used in previous request(s).', 'description' => 'The requested clientToken is duplicated.'],
],
[
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'IncorrectVswitchId', 'errorMessage' => 'The specified parameter VSwitchId is not valid.', 'description' => 'The vSwitch ID is invalid.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'DeploymentSet.NotFound', 'errorMessage' => 'The specified deployment set does not exist.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
['errorCode' => 'CallLxSdkFailed', 'errorMessage' => 'Error calling the order system, please try again later or contact service personnel.', 'description' => 'Error calling the order system, please try again later or contact service personnel.'],
],
],
'title' => 'Create one or more RDS Custom instances ',
'summary' => 'Invoke the RunRCInstances API and specify parameters such as ImageId, InstanceType, VSwitchId, and SecurityGroupId to create one or more RDS Custom instances. ',
'description' => '- Before creating an RDS Custom instance, submit a ticket to request that your Alibaba Cloud account be added to the whitelist. '."\n"
.'- Only subscription-type RDS Custom instances are supported. '."\n"
.'- Supported regions include Beijing, Shanghai, Shenzhen, and Hangzhou. ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:RunRCInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/*'],
],
],
],
],
'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"}]',
],
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A417FB41-A3D9-464E-AD0A-C7FE05C72E98', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '238028563', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStatus.Format', 'errorMessage' => 'Specified Status is not valid', 'description' => ''],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-09-05T09:56:19.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-07-14T18:01:15.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:StartDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'The instance ID.'."\n",
'type' => 'string',
'required' => true,
'example' => 'rc-l02u59b2kjfd2us0****',
'enum' => [],
'title' => '',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'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' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B993DA9-5272-5414-94E3-4CA8BA0146C2\\"\\n}","type":"json"}]',
'title' => 'StartRCInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:StartRCInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'operationType' => 'write',
],
'StopDBInstance' => [
'summary' => 'Suspends 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.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-bp1q915x50h****', 'title' => ''],
],
[
'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' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A417FB41-A3D9-464E-AD0A-C7FE05C72E98', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidStatus.Format', 'errorMessage' => 'Specified Status is not valid', 'description' => ''],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'ReadOnlyInstanceNotSupport', 'errorMessage' => 'Specified ReadOnly Instance not support this operation.', 'description' => 'Read-only instances do not support the operation.'],
['errorCode' => 'InvalidShareInstance.NotSupport', 'errorMessage' => 'The share dbInstance is not support.', 'description' => 'This operation is not supported for shared instances.'],
['errorCode' => 'ReadonlyInstanceNotSupport', 'errorMessage' => 'The operation is not permitted due to type of the instance.', 'description' => 'The specified read-only instance does not support this operation.'],
['errorCode' => 'InstanceHasReadOnlyInstanceNotSupportStop', 'errorMessage' => 'The instance has read-only instance , stop is not supported', 'description' => 'The instance cannot be stopped because it has a read-only instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'errorMessage' => 'The Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Meta db calling failed.', 'description' => 'An internal error occurred.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'The database instance type does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A417FB41-A3D9-464E-AD0A-C7FE05C72E98\\"\\n}","type":"json"}]',
'title' => 'StopDBInstance',
'description' => '### Supported database engines'."\n"
."\n"
.'- MySQL'."\n"
."\n"
.'- PostgreSQL'."\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"
.'[Suspend an ApsaraDB RDS for SQL Server instance](~~462504~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-12-05T11:13:47.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-07-14T18:01:15.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDBInstance'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:StopDBInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'StopRCInstance' => [
'summary' => 'Invoke StopRCInstance to stop a running RDS Custom instance. After the API is successfully invoked, the instance transitions from the Stopping state to the Stopped state. ',
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'StoppedMode',
'in' => 'query',
'schema' => ['description' => 'The stop mode to use when stopping the instance. Valid values:'."\n"
."\n"
.' - StopCharging: economical mode. When economical mode is enabled:'."\n"
.' - Computing resources are no longer billed.'."\n"
.' - System disk and data disk continue to be billed.'."\n"
.' - Because computing resources are revoked, the instance might fail to start due to insufficient inventory. In this case, try again later or change the instance type.'."\n"
."\n"
.' - KeepCharging: normal stop mode. The instance continues to incur charges after it is stopped. ', 'type' => 'string', 'required' => false, 'example' => 'KeepCharging', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'IncorrectInstanceStatus', 'errorMessage' => 'The current status of the resource does not support this operation.', 'description' => 'The current status of the resource does not support this operation.'],
['errorCode' => 'IncorrectInstanceStatus.Initializing', 'errorMessage' => 'The specified instance status does not support this operation.', 'description' => 'The specified instance status does not support this operation.'],
['errorCode' => 'InvalidStatus.ValueNotSupported', 'errorMessage' => 'The specified instance status is not supported for the operation.', 'description' => 'The status of the current instance does not support this operation.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E36DB6E-AE3B-53B6-A703-85F883FD1B2C\\"\\n}","type":"json"}]',
'title' => 'Stop an RDS Custom instance ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:StopRCInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/{#InstanceId}'],
],
],
],
],
],
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'GeneralIns.Creating', 'errorMessage' => 'The general instance is creating.', 'description' => 'An RDS instance is in production. Please wait.'],
['errorCode' => 'GeneralIns.Maintaining', 'errorMessage' => 'The general instance is maintaining.', 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['errorCode' => 'GeneralIns.Switching', 'errorMessage' => 'The general instance is Switching.', 'description' => 'A switchover for high availability is in progress. Please wait.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2021-08-13T09:39:20.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:SwitchDBInstanceHA',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'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', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65BDA532-28AF-4122-AA39-B382721EEE64', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:11:36.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceNetType'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:SwitchDBInstanceNetType',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'SwitchDBInstanceVpc' => [
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MigrateAlreadyExistsFault', 'errorMessage' => 'Duplicate migration is forbidden.', 'description' => 'The same data cannot be migrated twice.'],
['errorCode' => 'InvalidConnVPCId', 'errorMessage' => 'Specified conn vpc id is not valid.', 'description' => ''],
['errorCode' => 'InvalidInstanceKind.NotSupport', 'errorMessage' => 'The instance kind does not support this operation.', 'description' => 'The instance type does not support this operation.'],
['errorCode' => 'InvalidPrivateIpAddress.Mismatch', 'errorMessage' => 'Specified private IP address is not in the CIDR block of virtual switch.', 'description' => 'The VPC endpoint is invalid.'],
['errorCode' => 'MigrateAlreadyReadWriteSplitExistsFault', 'errorMessage' => 'The rds instance already has a given vpc migrate task.', 'description' => ''],
['errorCode' => 'APICallingFailed', 'errorMessage' => 'Api calling failed.', 'description' => 'An internal error occurred.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidClassicNetworkType.NotSupport', 'errorMessage' => 'The classic network type instance does not support this operation.', 'description' => 'This operation is not supported for classic network instances.'],
['errorCode' => 'InvalidParamForXfs', 'errorMessage' => 'Xfs instance must be single tenant standard instance.', 'description' => 'Xfs instance must be single tenant standard instance.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'SwitchDBInstanceVpc',
'summary' => 'Changes the virtual private cloud (VPC) and vSwitch for an ApsaraDB RDS instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-02-28T09:13:37.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-15T08:50:41.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T06:56:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-28T07:01:12.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-28T07:01:12.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceVpc'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:SwitchDBInstanceVpc',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AD222E9-E606-4A42-BF6D-8A4442913CEF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AD222E9-E606-4A42-BF6D-8A4442913CEF\\n","errorExample":""}]',
],
'SwitchOverMajorVersionUpgrade' => [
'summary' => 'Zero-downtime major version upgrade traffic switchover for RDS PostgreSQL.',
'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', 'title' => ''],
],
[
'name' => 'DBInstanceName',
'in' => 'query',
'schema' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pgm-m5e4gegx63fh92bn', 'title' => ''],
],
[
'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',
'title' => '',
],
],
[
'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', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Used to ensure the idempotence of the request and prevent duplicate submissions. The client generates this parameter value, which must be unique across different requests. It can contain a maximum of 64 ASCII characters and must not include non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCzxxxxxxxxxx', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","type":"json"}]',
'title' => 'Major Version Upgrade Switchover',
'description' => 'Applicable engine: '."\n"
.'* RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:SwitchOverMajorVersionUpgrade',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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******', 'title' => ''],
],
[
'name' => 'TargetInstanceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The name of the destination DR instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4neh0q12v1******', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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****', 'title' => ''],
'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****', 'title' => ''],
'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'zbtest', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'NoAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for account. We recommend that you add a payment method.', 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'SwitchReplicationLink',
'description' => '### [](#)Supported database engine'."\n"
."\n"
.'SQL Server'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:SwitchReplicationLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"135****\\",\\n \\"RequestId\\": \\"2F2DD69B-90AF-1E72-923C-87575658A9D9\\",\\n \\"TaskId\\": 0,\\n \\"TaskName\\": \\"zbtest\\"\\n}","type":"json"}]',
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
'required' => true,
'example' => 'rm-uf6wjk5xxxxxxx',
'maxItems' => 51,
'title' => '',
],
],
[
'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', 'title' => ''],
'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', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum value is 20.', 'description' => 'The maximum number of Tag is exceeded. The maximum value is 20.'],
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter - ResourceIds.N should not be null', 'description' => ''],
['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is blank', 'description' => 'The operation failed. The Tag.N.Key parameter is empty.'],
['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is blank', 'description' => 'The Tag.N.Value is empty.'],
['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contain duplicate key.', 'description' => 'The operation failed. A duplicate key is specified by the Tag.N.Key parameter.'],
['errorCode' => 'OperationDenied.QuotaExceed', 'errorMessage' => 'The maximum number of Tags is exceeded.', 'description' => 'The maximum number of Tags is exceeded.'],
['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.', 'description' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => ''],
['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
['errorCode' => 'InvalidRCInstanceName.NotFound', 'errorMessage' => 'The RDS Custom instance was not found.', 'description' => 'RDS Custom instance not found.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-11-15T07:28:00.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-12T07:34:45.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'rds:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/{#InstanceId}'],
],
],
],
],
],
'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-bp159vf****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidTaskType.Invalid', 'errorMessage' => 'Migrate task type Incremental is not supported, only support FULL backup migrate task.', 'description' => 'The incremental migration task type is not supported. Only complete backup migration task is supported.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidTask.NotFound', 'errorMessage' => 'Specified MigrateTaskId could not be found on RDS.', 'description' => 'No migration task ID is found in RDS.'],
['errorCode' => 'InvalidParameter.Invalid', 'errorMessage' => 'Specified MigrateTaskId is invalid.', 'description' => 'The value of the MigrateTaskId parameter is invalid.'],
['errorCode' => 'InvalidTaskStatus', 'errorMessage' => 'Current task status (Terminated/Failed) does not support.', 'description' => 'The current task status (Stopped) does not support the operation.'],
['errorCode' => 'UnfinishedTerminateMigrateTask', 'errorMessage' => 'Specified MigrateTaskId terminate failed.', 'description' => 'Failed to stop the migration.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateMigrateTask'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:TerminateMigrateTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'BusinessInfo',
'in' => 'query',
'schema' => ['description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'PromotionCode',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => 'The coupon code.'."\n", 'example' => '726122650073', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'rm-uf6wjk5****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5E6E09DE-5B12-4BFF-A55E-1C86EDE06D9A', 'title' => ''],
'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', 'title' => ''],
'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20515760028****', 'title' => ''],
'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' => 'POSTPAY', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidInstanceUseType.NotSupport', 'errorMessage' => 'Specified instanceUseType does not support in RDS.', 'description' => 'The operation failed. The role that is specified by the instanceUseType parameter is not supported for the RDS instance.'],
['errorCode' => 'InvalidOrderCharge.NotSupport', 'errorMessage' => 'The specified order charge does not support in RDS.', 'description' => ''],
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''],
['errorCode' => 'IncompleteAccountInfo', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['errorCode' => 'IncompleteTaxInfo', 'errorMessage' => 'Your tax information is incomplete. Complete your information before the operation.', 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['errorCode' => 'InvalidPaymentMethod.Incomplete', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InvalidPaymentMethod.Missing', 'errorMessage' => 'Your payment method is incomplete. We recommend that you add a payment method.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.'],
['errorCode' => 'InsuffcientBalanceOrBankAccount', 'errorMessage' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['errorCode' => 'InvalidPaymentMethod.NoAccess', 'errorMessage' => 'No payment method is specified for your account. Please contact your Customer Manager or open a ticket.', 'description' => ''],
['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.', 'description' => ''],
['errorCode' => 'OrderTaskAlreadyExists', 'errorMessage' => 'Order task already exists.', 'description' => 'The specified order task already exists.'],
['errorCode' => 'InvalidOldInstanceType.NotSupport', 'errorMessage' => 'Specified oldInstanceType does not support in RDS.', 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['errorCode' => 'OperationDenied.TimeLimit', 'errorMessage' => 'The interval between the two conversion operations must be greater than 15 minutes.', 'description' => 'The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.'],
['errorCode' => 'InvalidDBInstanceId.Malformed', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => ''],
['errorCode' => 'InvalidPayType.Malformed', 'errorMessage' => 'The specified parameter PayType is not valid.', 'description' => ''],
['errorCode' => 'InvalidResource.Format', 'errorMessage' => 'The specified parameter Resource is not valid.', 'description' => 'The resource ID is invalid.'],
['errorCode' => 'InvalidPayType.Format', 'errorMessage' => 'The specified parameter PayType is not valid.', 'description' => 'The payment type is invalid.'],
['errorCode' => 'InvalidUsedTime.Format', 'errorMessage' => 'The specified parameter UsedTime is not valid.', 'description' => 'UsedTime is not defined.'],
['errorCode' => 'InvalidPeriod.Format', 'errorMessage' => 'The specified parameter Period is not valid.', 'description' => ''],
['errorCode' => 'InvalidPeriodOrUsedTime.Format', 'errorMessage' => 'The specified parameter Period and UsedTime are not valid.', 'description' => ''],
['errorCode' => 'InvalidDiscountCoupon.Malformed', 'errorMessage' => 'The specified discount coupon is not valid.', 'description' => ''],
['errorCode' => 'InsufficientQuota.NoEnough', 'errorMessage' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', 'description' => 'The quota is insufficient. Contact your channel partner to request a quota increase.'],
['errorCode' => 'SYSTEM.ILLEGALARGUMENT', 'errorMessage' => 'The current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.', 'description' => ''],
['errorCode' => 'AccountMoneyValidate.error', 'errorMessage' => 'Insufficient funds available in the account.', 'description' => ''],
['errorCode' => 'ContainForbiddenLabel.error', 'errorMessage' => 'There is a label that prohibits placing an order, and the order cannot be placed.', 'description' => ''],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => '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.', 'description' => '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.', 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the subscription limit. You are not allowed to switch to the subscription method.'],
['errorCode' => 'InvalidParam.POSTPAY', 'errorMessage' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', 'description' => 'When the classic network is offline, the current instance is of the classic network type and has exceeded the time limit of the post-payment instance. You cannot switch the payment method to post-payment.'],
['errorCode' => 'Order.InstHasUnsettledBills', 'errorMessage' => 'You currently have outstanding bills, please settle them first.', 'description' => 'You currently have outstanding bills, please settle them first.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available 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.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => '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.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OperationDenied.LockMode', 'errorMessage' => 'The operation is not permitted when the instance locked.', 'description' => 'The operation failed. The RDS instance is locked possibly because the balance within your Alibaba Cloud account is insufficient. Top up or add funds to your Alibaba Cloud account to unlock the RDS instance.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2024-11-19T13:27:16.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-08-29T14:44:38.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-08-15T06:50:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-13T13:26:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-14T01:37:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-11T08:59:51.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-03-11T12:50:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-08T03:22:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-05-04T01:41:35.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-26T12:51:10.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformDBInstancePayType'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:TransformDBInstancePayType',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2022-06-23T12:13:24.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockAccount'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UnlockAccount',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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-uf6wjk5****', 'title' => ''],
'required' => true,
'example' => 'rm-uf6wjk5xxxxxxx',
'maxItems' => 51,
'title' => '',
],
],
[
'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', 'title' => ''],
'required' => false,
'example' => 'testkey1',
'maxItems' => 21,
'title' => '',
],
],
],
'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', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The number of parameter Tags is exceed, Valid : 20', 'description' => ''],
['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The number of ResourceIds parameter is exceed , Valid : 50', 'description' => ''],
['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The Tag.N.Value parameter is blank', 'description' => 'The Tag.N.Value is empty.'],
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter - ResourceIds.N should not be null', 'description' => ''],
['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The Tag.N.Key parameter is blank', 'description' => 'The operation failed. The Tag.N.Key parameter is empty.'],
['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'ResourceId does not refer to an existing DB instance.', 'description' => 'The operation failed. The value of the ResourceId parameter is not the ID of an existing RDS instance.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The parameter ResourceType is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2024-10-31T06:37:08.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-09-01T02:53:09.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'rds:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'Custom', 'arn' => 'acs:rds:{#regionId}:{#accountId}:custom/{#InstanceId}'],
],
],
],
],
],
'UpdateDBInstanceReplication' => [
'summary' => 'Updates a replication channel for a native replication instance.',
'path' => '',
'methods' => ['post'],
'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.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1234567890abcdef', 'maxLength' => 30, 'minLength' => 1, 'title' => ''],
],
[
'name' => 'ChannelName',
'in' => 'query',
'schema' => ['description' => 'The unique name for the replication channel.', 'type' => 'string', 'example' => 'replication-channel-001', 'maxLength' => 64, 'required' => false, 'title' => ''],
],
[
'name' => 'MasterHost',
'in' => 'query',
'schema' => ['description' => 'The IP address or domain name of the master database.', 'type' => 'string', 'example' => '192.168.1.100', 'maxLength' => 128, 'minLength' => 1, 'required' => false, 'title' => ''],
],
[
'name' => 'MasterPort',
'in' => 'query',
'schema' => ['description' => 'The port number of the master database. Default: 3306.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '65535', 'minimum' => '1', 'example' => '3306', 'required' => false, 'title' => ''],
],
[
'name' => 'MasterUser',
'in' => 'query',
'schema' => ['description' => 'The username for the replication account on the master database. Specify this parameter only to update the username.', 'type' => 'string', 'example' => 'repl_user', 'maxLength' => 32, 'minLength' => 1, 'required' => false, 'title' => ''],
],
[
'name' => 'MasterPassword',
'in' => 'query',
'schema' => ['description' => 'The Base64-encoded password for the replication user on the master database.', 'type' => 'string', 'example' => 'U2VjdXJlUGFzczEyMyE=', 'maxLength' => 44, 'minLength' => 8, 'required' => false, 'title' => ''],
],
[
'name' => 'Operation',
'in' => 'query',
'schema' => [
'description' => 'The operation to perform on the replication channel. Valid values: Start, Stop, Restart, and Rebuild.',
'type' => 'string',
'required' => true,
'example' => 'Start',
'enum' => ['Stop', 'Start', 'Restart', 'Rebuild'],
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'title' => 'Schema of Response ',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'ID of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => '17F57FEE-EA4F-4337-8D2E-9C23CAA63D74'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidReplicationChannelName.Forbid', 'errorMessage' => 'Specified replication channel name is forbidden (reserved for internal use).', 'description' => 'Specified replication channel name is forbidden (reserved for internal use).'],
['errorCode' => 'InvalidReplicationChannel.Duplicate', 'errorMessage' => 'Specified replication channel already exists.', 'description' => 'Specified replication channel already exists.'],
['errorCode' => 'MissingReplicationParam', 'errorMessage' => 'Missing required parameters for replication operation: MasterHost, MasterPort, MasterUser, MasterPassword.', 'description' => 'Missing necessary replication-related parameters'],
['errorCode' => 'MissingOperationParam', 'errorMessage' => 'Missing required parameter: Operation.', 'description' => 'Missing required parameter: Operation.'],
['errorCode' => 'InvalidOperation.NotSupport', 'errorMessage' => 'Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild.', 'description' => 'Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild.'],
['errorCode' => 'InvalidMasterPort.Format', 'errorMessage' => 'Specified MasterPort format is not valid.', 'description' => 'Specified MasterPort format is not valid.'],
['errorCode' => 'MissingRebuildParam', 'errorMessage' => 'Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword.', 'description' => 'Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword.'],
],
404 => [
['errorCode' => 'InvalidReplicationChannel.NotFound', 'errorMessage' => 'Specified replication channel does not exist.', 'description' => 'Specified replication channel does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update replication channel ',
'description' => '### Applicable engines'."\n"
."\n"
.'RDS MySQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'>Before you call this API operation, review the related documentation to understand its prerequisites and consequences.>'."\n"
.'[RDS MySQL native replication instance](~~2856487~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17F57FEE-EA4F-4337-8D2E-9C23CAA63D74\\"\\n}","type":"json"}]',
],
'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****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'name' => 'Extensions',
'in' => 'query',
'schema' => ['description' => 'The name of the extension. Separate multiple extensions with commas (,).'."\n", 'type' => 'string', 'required' => true, 'example' => 'citext', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmy****', 'title' => ''],
],
],
'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'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBName.Format', 'errorMessage' => 'Specified DB name is not valid.', 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'Specified instance does not exist or not support.', 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePostgresExtensions'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpdatePostgresExtensions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'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-g14d0m772f7b****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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, 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'BackupId' => ['description' => 'The ID of the backup file.'."\n", 'type' => 'string', 'example' => 'b-lvn2365ev9f1****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '29EBB093-DBD8-5EEB-841D-E611B88CDE4B', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParam', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''],
['errorCode' => 'OperationDenied.Product', 'errorMessage' => 'The product code is not supported.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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",
'changeSet' => [
['createdAt' => '2023-07-25T01:51:05.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserBackupFile'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpdateUserBackupFile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''],
],
[
'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****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'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', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '10254125', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidOrderTask.NotSupport', 'errorMessage' => 'The Current InstanceId exist Order Task in RDS.', 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['errorCode' => 'InvalidEVENT', 'errorMessage' => 'Current DB instance has event schedule, this operation is not supported.', 'description' => ''],
['errorCode' => 'InvalidSSLstatus', 'errorMessage' => 'Current DB instance has SSL enabled, this operation is not supported.', 'description' => 'This operation is not supported because this instance has SSL enabled.'],
['errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Current DB instance has TDE enabled, this operation is not supported.', 'description' => 'This operation is not supported because TDE is enabled on the instance.'],
['errorCode' => 'InvalidDBInstanceConnType.Format', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read instance running in unsupported states.', 'description' => ''],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidMinorVersion.NotFound', 'errorMessage' => 'Specified minor version does not exists.', 'description' => 'The operation failed. The database engine version cannot be found.'],
['errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', 'description' => '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.', 'description' => ''],
['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'The engine version does not support the operation.', 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
['errorCode' => 'IncorrectEngineTypeMyisam', 'errorMessage' => 'Current DB instance has MyISAM table, and it does not support this operation.', 'description' => 'The major version of MySQL is upgraded. Check whether the instance has MyISAM engine tables.'],
['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Current DB instance has account aliyun_root,and it does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'UnsupportedReadOrBakReadState', 'errorMessage' => 'Current DB instance has read or bak read running in unsupport states', 'description' => 'The current instance is in the unsupported read or bak read state.'],
['errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', 'description' => ''],
['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'ClusterNotSupport', 'description' => 'The operation is not supported for the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'UnsupportedFtsIndex', 'errorMessage' => 'Current DB instance has fts index. Please delete in space fts index.', 'description' => 'The current instance contains full-text indexes created in the system tablespace. Delete and rebuild the corresponding full-text indexes before upgrading.'],
['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.', 'description' => 'The current instance minor version is less than 20221130. Please upgrade the minor version before deleting or rebuilding the full-text index.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstance.NotFound', 'errorMessage' => 'The specified instance does not exist or is not supported.', 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-04-02T12:45:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-02-07T02:37:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-03-12T13:45:34.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-14T08:46:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-07-19T09:58:31.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-23T06:56:49.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-23T11:14:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-23T11:14:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-23T11:14:59.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-12-23T11:14:59.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceEngineVersion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpgradeDBInstanceEngineVersion',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'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":""}]',
],
'UpgradeDBInstanceKernelVersion' => [
'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-bp****', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
[
'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', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'rm-bp****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'DA2ECBA0-4745-4491-9166-799FF8984AC9', 'title' => ''],
'TargetMinorVersion' => ['description' => 'The new minor engine version of the instance.'."\n", 'type' => 'string', 'example' => 'xcluster80_20210305', 'title' => ''],
'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '226917711', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidMinorVerison.NotFound', 'errorMessage' => 'Specify minor version not founud.', 'description' => 'The operation failed. The minor engine version cannot be found.'],
['errorCode' => 'InstanceMissingMinorVersionAttr', 'errorMessage' => 'Specify instance has no minor_version attribute.', 'description' => 'The operation failed. The minor_version parameter is empty. Submit a ticket.'],
['errorCode' => 'InvalidMinorVersionLowerThanInstance', 'errorMessage' => 'Specify minor version cannot not be lower than current instance.', 'description' => 'The new database engine version cannot be earlier than the database engine version that is run on the RDS instance. Check the new database engine version.'],
['errorCode' => 'InvalidMinorVersionAlreadyLatest', 'errorMessage' => 'Minor version for instance is already the latest version.', 'description' => 'The RDS instance runs the latest minor engine version.'],
['errorCode' => 'MissingParameter.MinorVersionTag', 'errorMessage' => 'You must specify the parameter MinorVersionTag.', 'description' => 'The minor engine version cannot be left unspecified.'],
['errorCode' => 'EngineNotSupported', 'errorMessage' => 'The engine does not support the operation.', 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', 'description' => 'The task already exists.'],
['errorCode' => 'UpgradeSQLServerMinorVersionFail', 'errorMessage' => 'Upgrade Minor Version for SQLServer failed.', 'description' => 'Failed to update the minor version of SQL Server.'],
['errorCode' => 'UnsupportExtendDisk.NotSupport', 'errorMessage' => 'Specified DB instance is unsupport extend disk.', 'description' => 'Disk expansion is not supported on the specified instance.'],
['errorCode' => 'InvalidSwitchMode.NotFound', 'errorMessage' => 'Specified Parameter UpgradeTime is Invalid.', 'description' => ''],
['errorCode' => 'InvalidDBInstanceConnType.Classic', 'errorMessage' => 'Specified DB instance ConnectionAddress include classic net.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceTdeStatus', 'errorMessage' => 'Source DB instance and Target DB instance TDEStatus does not support this operation.', 'description' => ''],
['errorCode' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'errorMessage' => 'The instance backup method is snapshot backup, this operation is not supported', 'description' => 'This operation is not supported for instances that have snapshot backup enabled.'],
['errorCode' => 'TDEInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened TDE, this operation is not supported', 'description' => 'This operation is not supported for instances that have TDE enabled.'],
['errorCode' => 'SSLInstanceNotSupportThisOperation', 'errorMessage' => 'The instance opened SSL, upgrade is not this operation', 'description' => 'This operation is not supported for instances that have SSL enabled.'],
['errorCode' => 'BYOLInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOL instance is not supported this operation', 'description' => 'This operation is not supported for instances that are created from BYOL images.'],
['errorCode' => 'BYOKInstanceNotSupportThisOperation', 'errorMessage' => 'The BYOK instance is not supported this operation', 'description' => 'This operation is not supported for instances that have disk encryption enabled.'],
['errorCode' => 'ADInstanceNotSupportThisOperation', 'errorMessage' => 'The AD instance is not supported this operation', 'description' => 'This operation is not supported for instances that have been joined to an AD domain.'],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => '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.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'SecondaryAddrNotSupportThisOperation', 'errorMessage' => 'The instance has a secondary instance address, so updates are not allowed.', 'description' => 'The instance contains the read-only address of the secondary node and cannot be upgraded.'],
],
403 => [
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => ''],
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['errorCode' => 'SSLNotSupport', 'errorMessage' => 'The CharacterType of instance does not support SSL', 'description' => ''],
['errorCode' => 'OperationDenied.PrePayTypeNotSupported', 'errorMessage' => 'The operation is not permitted due to pay type of instance.', 'description' => 'Subscription instances cannot be directly deleted.'],
['errorCode' => 'CurrentRecoveryModelNotSupportThisAction', 'errorMessage' => 'Current recovery model not supported this action.', 'description' => 'The current recovery model does not support.'],
['errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'UnsupportedByBlueGreenDeployment', 'errorMessage' => 'Operation prohibited due to blue green deployment.', 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'InvalidMaxscaleMinorVersion.Format', 'errorMessage' => 'Specified Maxscale Minor Version is Invalid.', 'description' => ''],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'title' => 'UpgradeDBInstanceKernelVersion',
'summary' => 'Updates the minor engine version of an ApsaraDB RDS instance.',
'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' => ' ',
'changeSet' => [
['createdAt' => '2025-03-25T13:12:02.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-11T03:20:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-14T08:46:28.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-21T09:20:09.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-11-07T02:56:36.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-09-20T06:32:01.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-06-09T03:03:59.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-05-16T02:12:07.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-03-01T09:55:19.000Z', 'description' => 'Error codes changed, Response parameters changed'],
['createdAt' => '2022-06-23T06:56:50.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpgradeDBInstanceKernelVersion',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"rm-bp****\\",\\n \\"RequestId\\": \\"DA2ECBA0-4745-4491-9166-799FF8984AC9\\",\\n \\"TargetMinorVersion\\": \\"xcluster80_20210305\\",\\n \\"TaskId\\": \\"226917711\\"\\n}","type":"json"}]',
],
'UpgradeDBInstanceMajorVersion' => [
'summary' => 'Starts a major version upgrade for an RDS 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. The vCPU and memory specifications must be greater than or equal to those of the source instance. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'For example, if the source instance type is `pg.n2.small.2c` with 1 vCPU and 2 GB of memory, you can upgrade it to `pg.n2.medium.2c`, which has 2 vCPUs and 4 GB of memory.'."\n"
."\n"
.'> For information about the instance type codes for RDS for PostgreSQL, see [Instance types of primary ApsaraDB RDS for PostgreSQL instances](~~276990~~).', 'type' => 'string', 'required' => false, 'example' => 'pg.n2.medium.2c', 'title' => ''],
],
[
'name' => 'DBInstanceStorage',
'in' => 'query',
'schema' => ['description' => 'The new storage capacity of the instance. Unit: GB. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- **ESSD PL1 cloud disk**: 20 to 3,200'."\n"
."\n"
.'- **ESSD PL2 cloud disk**: 500 to 3,200'."\n"
."\n"
.'- **ESSD PL3 cloud disk**: 1,500 to 3,200'."\n"
."\n"
.'- **high-performance cloud disk**: 40 to 2,000'."\n"
."\n"
.'> When you upgrade the major version of an instance that uses high-performance local disks, you can scale down the storage capacity. For information about the minimum storage capacity, see [Upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance](~~203309~~).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => ['description' => 'The billing method. This parameter is fixed to `Postpaid`, which specifies the pay-as-you-go billing method.'."\n"
."\n"
.'> To change the billing method of the instance after the upgrade, see [Switch an ApsaraDB RDS for PostgreSQL instance from pay-as-you-go to subscription](~~96743~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Postpaid', 'title' => ''],
],
[
'name' => 'InstanceNetworkType',
'in' => 'query',
'schema' => ['description' => 'The network type of the instance after the upgrade. This parameter is fixed to VPC. Major version upgrades are supported only for instances in a VPC.'."\n"
."\n"
.'If your instance uses the classic network, you must first switch its network type to VPC. For more information, see [Change the network type of an ApsaraDB RDS for PostgreSQL instance](~~96761~~).', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''],
],
[
'name' => 'SwitchTimeMode',
'in' => 'query',
'schema' => ['description' => 'Specifies when to perform the switchover. This parameter is valid only when **SwitchOver** is set to **true**.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- **Immediate**: Performs the switchover immediately.'."\n"
."\n"
.'- **MaintainTime**: Performs the switchover during the maintenance window. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window.', 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => '2021-07-10T13:15:12Z', 'title' => ''],
],
[
'name' => 'SwitchOver',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to automatically switch your workloads to the new instance after the upgrade.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- **true**: automatic switchover. This option is typically used for a formal upgrade after you confirm that your workloads can run as expected on the new major engine version.'."\n"
."\n"
.'- **false**: no automatic switchover. This option is typically used to test the compatibility of your workloads with the new major engine version before the formal upgrade.'."\n"
."\n"
.'> * If you select automatic switchover:'."\n"
.'>'."\n"
.'> - The switchover cannot be rolled back. Proceed with caution.'."\n"
.'>'."\n"
.'> - During the switchover, the source instance becomes read-only. We recommend that you perform the switchover during off-peak hours.'."\n"
.'>'."\n"
.'> - If the source instance has attached read-only instances, you cannot perform a switchover. You can only upgrade the instance without a switchover, in which case the read-only instances are not cloned. After the upgrade is complete, you must create read-only instances for the new instance that runs RDS for PostgreSQL.'."\n"
.'>'."\n"
.'> * If you do not select automatic switchover:'."\n"
.'>'."\n"
.'> - The migration does not affect your workloads on the source instance.'."\n"
.'>'."\n"
.'> - If you upgrade the instance without a switchover, you must change the database endpoint in your application to the endpoint of the new instance after the migration is complete. For more information about how to view endpoints, see [View and change the internal and public endpoints and port numbers of an ApsaraDB RDS for PostgreSQL instance](~~96788~~).', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'CollectStatMode',
'in' => 'query',
'schema' => ['description' => 'Specifies when to run the `ANALYZE` command to collect statistics on the database.'."\n"
."\n"
.'- **Before**: collects statistics before the switchover to ensure service stability. If the instance contains a large amount of data, the upgrade may take a long time.'."\n"
."\n"
.'- **After**: collects statistics after the switchover. This speeds up the upgrade. However, after the upgrade, query execution plans for tables that do not have up-to-date statistics may be inaccurate. This can cause database downtime during peak hours.'."\n"
."\n"
.'> For upgrades without a switchover, `Before` means statistics are collected before the new instance accepts read and write operations, and `After` means statistics are collected after the new instance accepts read and write operations.', 'type' => 'string', 'required' => false, 'example' => 'After', 'title' => ''],
],
[
'name' => 'TargetMajorVersion',
'in' => 'query',
'schema' => ['description' => 'The target major engine version for the upgrade. The value must match the version specified in the `UpgradeDBInstanceMajorVersionPrecheck` call.'."\n"
."\n"
.'> You can call the `UpgradeDBInstanceMajorVersionPrecheck` operation to perform a precheck for a major version upgrade.', 'type' => 'string', 'required' => false, 'example' => '13.0', 'title' => ''],
],
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'pgm-bp1gm3yh0ht1****', 'title' => ''],
],
[
'name' => 'VPCId',
'in' => 'query',
'schema' => ['description' => 'The VPC ID. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'You can call the `DescribeDBInstanceAttribute` operation to view the VPC ID of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1opxu1zkhn00gzv****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The ID of the vSwitch for the target instance. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'- If the source instance is on the Basic Edition, specify the vSwitch ID for the target instance.'."\n"
."\n"
.'- If the source instance is on the High-availability Edition, you can specify the vSwitch IDs for the primary and secondary instances of the target instance. Separate the IDs with a comma (,).'."\n"
."\n"
.'> The specified vSwitch must be in the same availability zone as the source instance. You can call the `DescribeVSwitches` operation to query vSwitch IDs.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp10aqj6o4lclxdrm****,vsw-bp10aqj6o4lclxdrm****', 'title' => ''],
],
[
'name' => 'PrivateIpAddress',
'in' => 'query',
'schema' => ['description' => 'This parameter is not required. The system automatically assigns a private IP address based on the specified `VPCId` and `vSwitchId`.', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX', 'title' => ''],
],
[
'name' => 'UsedTime',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''],
],
[
'name' => 'DBInstanceStorageType',
'in' => 'query',
'schema' => ['description' => 'The storage type of the instance after the upgrade.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- **cloud\\_ssd**: SSD cloud disk'."\n"
."\n"
.'- **cloud\\_essd**: ESSD PL1 cloud disk'."\n"
."\n"
.'- **cloud\\_essd2**: ESSD PL2 cloud disk'."\n"
."\n"
.'- **cloud\\_essd3**: ESSD PL3 cloud disk'."\n"
."\n"
.'- **general\\_essd**: high-performance cloud disk'."\n"
."\n"
.'Major version upgrades are based on cloud disk snapshots. The available storage types depend on the source instance\'s storage type:'."\n"
."\n"
.'- If the source instance uses SSD cloud disks, you can select only SSD cloud disks.'."\n"
."\n"
.'- If the source instance uses ESSD cloud disks, you can select ESSD PL1, ESSD PL2, ESSD PL3, or high-performance cloud disks.'."\n"
."\n"
.'- If the source instance uses high-performance local disks, you can select ESSD PL1, ESSD PL2, ESSD PL3, or high-performance cloud disks.', 'type' => 'string', 'required' => false, 'example' => 'cloud_essd', 'title' => ''],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'The ID of the primary availability zone for the target instance. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'You can call the `DescribeRegions` operation to query availability zone IDs.'."\n"
."\n"
.'You can place the new instance in a different availability zone within the same region as the source instance after the upgrade.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
[
'name' => 'ZoneIdSlave1',
'in' => 'query',
'schema' => ['description' => 'The ID of the secondary availability zone for the target instance. This parameter applies only if the source instance uses the High-availability Edition. This parameter is not required if **UpgradeMode** is set to **inPlaceUpgrade** or **zeroDownTimeUpgrade**.'."\n"
."\n"
.'You can place the new secondary instance in a different availability zone within the same region as the source instance after the upgrade.'."\n"
."\n"
.'You can call the `DescribeRegions` operation to query availability zone IDs.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
[
'name' => 'ZoneIdSlave2',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''],
],
[
'name' => 'UpgradeMode',
'in' => 'query',
'schema' => ['description' => 'The upgrade mode. This parameter is required if **SwitchOver** is set to **true**. Valid values:'."\n"
."\n"
.'- **inPlaceUpgrade**: an in-place upgrade. The major version upgrade is performed on the source instance, and a new instance is not created. After the upgrade, the major engine version of the source instance is updated, and the instance retains its original order information, instance name, tags, CloudMonitor alert rules, and backup rules.'."\n"
."\n"
.'- **blueGreenDeployment**: a blue-green deployment. The major version upgrade retains the source instance and creates a new instance that runs the new major version. You are not charged for the new instance during its creation. Billing for the new instance starts after it is created, and its billing method may change. After the upgrade, billing applies to both the source and new instances. The new instance does not inherit the discounts of the source instance.'."\n"
."\n"
.'- **zeroDownTimeUpgrade**: a zero-downtime upgrade. The system uses `pg_upgrade` to upgrade the source instance to the target version and uses native logical replication for incremental updates. During the upgrade, you can perform a manual switchover and validate the new instance before the switchover. From the start of the upgrade until the manual switchover, the instance supports both read and write operations. During the switchover, the instance is read-only for a few seconds.', 'type' => 'string', 'required' => false, 'example' => 'inPlaceUpgrade', 'title' => ''],
],
[
'name' => 'CustomExtraInfo',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'AllowDDL',
'in' => 'query',
'schema' => ['description' => 'This parameter is reserved.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'DBInstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'pgm-bp1gm3yh0ht1****', 'title' => ''],
'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '21128667463****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '006729E5-2A33-5955-89E3-651D3F44EBE6', 'title' => ''],
'TaskId' => ['description' => 'A reserved parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '416980000', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidUpgradePrecheckResult', 'errorMessage' => 'The upgrade precheck failed. No successful precheck task found in the past 7 days', 'description' => 'The upgrade precheck failed. No successful precheck task is found within the last 7 days.'],
['errorCode' => 'TargetEngineVersion.Parameters.NotFound', 'errorMessage' => 'targetEngineVersion is missing in the request.', 'description' => 'The targetEngineVersion is missing in the request.'],
['errorCode' => 'InvalidDBInstanceStorageType', 'errorMessage' => 'The specified DBInstanceStorageType is invalid.', 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['errorCode' => 'InvalidInstanceNetworkType', 'errorMessage' => 'The specified InstanceNetworkType is invalid.', 'description' => 'The specified InstanceNetworkType is invalid.'],
['errorCode' => 'InvalidVPCId', 'errorMessage' => 'The specified VPCId is invalid.', 'description' => 'The specified VPCId parameter is invalid.'],
['errorCode' => 'InvalidDedicatedHostGroupId', 'errorMessage' => 'The specified DedicatedHostGroupId is invalid.', 'description' => 'The specified DedicatedHostGroupId parameter is invalid.'],
['errorCode' => 'InvalidPayType', 'errorMessage' => 'The specified PayType is invalid.', 'description' => 'The specified PayType is invalid.'],
['errorCode' => 'InvalidEngineVersion', 'errorMessage' => 'The specified EngineVersion is invalid.', 'description' => 'The specified EngineVersion parameter is invalid.'],
['errorCode' => 'InvalidDBInstanceStorage', 'errorMessage' => 'The specified DBInstanceStorage is invalid.', 'description' => 'The specified DBInstanceStorage parameter is invalid.'],
['errorCode' => 'InvalidSwitchOver', 'errorMessage' => 'The specified SwitchOver is invalid.', 'description' => 'The specified SwitchOver parameter is invalid.'],
['errorCode' => 'PrimaryInstanceWithReadonlyNotSupport', 'errorMessage' => 'The specified primary instance with the read-only instance does not support the operation.', 'description' => 'This operation is not supported for the specified primary instance that has a read-only instance.'],
['errorCode' => 'InvalidSwitchTimeMode', 'errorMessage' => 'The specified SwitchTimeMode is invalid.', 'description' => 'The specified SwitchTimeMode parameter is invalid.'],
['errorCode' => 'InvalidSwitchTime', 'errorMessage' => 'The specified SwitchTime is invalid.', 'description' => 'The specified SwitchTime parameter is invalid.'],
['errorCode' => 'InvalidCollectStats', 'errorMessage' => 'The specified CollectStats is invalid.', 'description' => 'The specified CollectStats parameter is invalid.'],
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The current instance state does not support this operation.', 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['errorCode' => 'InvalidDBinstanceClass.ValueNotSupported', 'errorMessage' => 'The specified parameter DBinstanceClass is invalid.', 'description' => 'The specified parameter DBinstanceClass is invalid.'],
['errorCode' => 'InvalidUpgradeMode', 'errorMessage' => 'The Specified UpgradeMode is not valid.', 'description' => 'The specified upgrade mode is invalid.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'InvalidVSwitchId.Format', 'errorMessage' => 'The specified vswitch Id format is incorrect.', 'description' => ''],
['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.', 'description' => 'This upgrade method cannot be selected for local disk instances. For cloud disk instances, we recommend that you upgrade the minor version.'],
],
403 => [
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The database instance does not exist.', 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', 'description' => 'The operation failed. The RDS instance is locked.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InvalidUpgradeMode', 'errorMessage' => 'The Specified Parameter UpgradeMode is not valid.', 'description' => 'Parameter UpgradeMode value error'],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceId\\": \\"pgm-bp1gm3yh0ht1****\\",\\n \\"OrderId\\": \\"21128667463****\\",\\n \\"RequestId\\": \\"006729E5-2A33-5955-89E3-651D3F44EBE6\\",\\n \\"TaskId\\": 416980000\\n}","type":"json"}]',
'title' => 'UpgradeDBInstanceMajorVersion',
'description' => '### Applicable engine'."\n"
."\n"
.'RDS PostgreSQL'."\n"
."\n"
.'### Related documentation'."\n"
."\n"
.'This is a paid API operation. Before you call this operation, read the related documentation to understand the fees, prerequisites, and impacts.'."\n"
."\n"
.'[Upgrade the major version of an RDS PostgreSQL instance](~~203309~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-02-14T08:05:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-10-31T06:37:06.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-27T14:32:13.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-23T08:33:17.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-08-22T16:01:01.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2024-06-03T09:07:03.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-05-22T06:50:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-27T09:09:24.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-10-25T03:45:05.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceMajorVersion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpgradeDBInstanceMajorVersion',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:*:{#accountId}:dbinstance/{#DBInstanceId}'],
],
],
],
],
],
'UpgradeDBInstanceMajorVersionPrecheck' => [
'summary' => 'This API is used to perform a pre-check before upgrading the major version of RDS MySQL or RDS PostgreSQL.'."\n",
'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****', 'title' => ''],
],
[
'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' => '17.0', 'title' => ''],
],
[
'name' => 'UpgradeMode',
'in' => 'query',
'schema' => [
'description' => 'Upgrade mode. Valid values: '."\n"
."\n"
.'- **zeroDownTimeUpgrade**: Zero downtime. '."\n"
.'- **inPlaceUpgrade**: In-place upgrade. '."\n"
.'- **greenBlueDeployment**: Blue-green deployment. '."\n",
'type' => 'string',
'enum' => [],
'required' => false,
'example' => 'zeroDownTimeUpgrade',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'pgm-bp1c808s731l****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4', 'title' => ''],
'TargetMajorVersion' => ['description' => 'The new major engine version of the instance.'."\n", 'type' => 'string', 'example' => '12.0', 'title' => ''],
'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '41698****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName.NotFound', 'errorMessage' => 'The specified DB instance name does not exist.', 'description' => 'The instance name does not exist.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'InvalidSourceCategory', 'errorMessage' => 'specified source category is invalid.', 'description' => 'The specified source category is invalid.'],
['errorCode' => 'InvalidBizType.Format', 'errorMessage' => 'Specified biz type is not valid.', 'description' => ''],
['errorCode' => 'MinorVersionNotSupport', 'errorMessage' => 'The current database minor version does not support the operation.', 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
['errorCode' => 'ClassicNetDisabled', 'errorMessage' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', 'description' => 'The classic network address is currently disabled and the instance cannot perform configuration changes.'],
['errorCode' => 'InvalidTDEstatus', 'errorMessage' => 'Current DB instance has TDE enabled, this operation is not supported.', 'description' => 'This operation is not supported because TDE is enabled on the instance.'],
],
403 => [
['errorCode' => 'ParamNotFound', 'errorMessage' => 'The parameter is not found for the interface.', 'description' => 'The parameter is not found for the interface.'],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'MaxscaleMinorVersionNotSupport', 'errorMessage' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['errorCode' => 'ReadInstanceNotSupport', 'errorMessage' => 'Instances with read-only do not support this operation.', 'description' => ''],
['errorCode' => 'DBClusterNotSupported', 'errorMessage' => 'The requested operation can not be performed while the cluster is not sale.', 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
],
[
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
['errorCode' => 'HostInfo.NotFound', 'errorMessage' => 'The specified host info is not found.', 'description' => ''],
],
500 => [
['errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', 'description' => ''],
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"pgm-bp1c808s731l****\\",\\n \\"RequestId\\": \\"99C1FEEE-FB44-5342-8EBA-DC1E1A1557A4\\",\\n \\"TargetMajorVersion\\": \\"12.0\\",\\n \\"TaskId\\": \\"41698****\\"\\n}","type":"json"}]',
'title' => 'Pre-check for RDS Major Version Upgrade '."\n",
'description' => '### Applicable Engines '."\n"
.'RDS MySQL '."\n"
."\n"
.'RDS PostgreSQL '."\n"
."\n"
.'### Related Function Documentation '."\n"
.'>Before using this API, carefully read the Function Documentation to ensure you fully understand the prerequisites for using the API and the Impact of its use before performing any operation.> '."\n"
."\n"
.'- [RDS MySQL Major Version Upgrade Check Report](~~2794383~~) '."\n"
.'- [Upgrade the Major Version of an RDS PostgreSQL Database](~~2879540~~) '."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-17T10:19:32.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-10-10T13:03:22.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-07-05T06:48:30.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-06-07T01:46:53.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-25T03:45:05.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2021-10-25T03:45:05.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceMajorVersionPrecheck'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [],
],
'UpgradeDBProxyInstanceKernelVersion' => [
'summary' => 'Upgrades the minor kernel version of a database proxy.',
'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 instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rm-uf6wjk5****', 'title' => ''],
],
[
'name' => 'UpgradeTime',
'in' => 'query',
'schema' => ['description' => 'The upgrade time. Valid values:'."\n"
."\n"
.'- **MaintainTime** (Default): The upgrade runs during the [maintenance window](~~610402~~).'."\n"
."\n"
.'- **Immediate**: The upgrade runs immediately.'."\n"
."\n"
.'- **SpecifyTime**: The upgrade runs at a specified time.', 'type' => 'string', 'required' => false, 'example' => 'MaintainTime', 'title' => ''],
],
[
'name' => 'SwitchTime',
'in' => 'query',
'schema' => ['description' => 'The time at which to perform the upgrade. Format: *yyyy-MM-dd*T*HH:mm:ss*Z (UTC time).'."\n"
."\n"
.'> This parameter is required only when **UpgradeTime** is set to **SpecifyTime**.', 'type' => 'string', 'required' => false, 'example' => '2019-07-10T13:15:12Z', 'title' => ''],
],
[
'name' => 'TargetMinorVersion',
'in' => 'query',
'schema' => ['description' => 'The new minor version of the instance. You can find the new minor version from the **TargetMinorVersion** parameter in the response of the [DescribeDBProxyTargetVersion](~~API.DescribeDBProxyTargetVersion~~) operation.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'DBProxyEngineType',
'in' => 'query',
'schema' => ['description' => 'A reserved parameter. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'DBInstanceName' => ['description' => 'The proxy instance ID.', 'type' => 'string', 'example' => 'bu9****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '44537EC8-DFA2-4745-B579-E733FF2C5B9A', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '334362871', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidDBInstanceName', 'errorMessage' => 'Specified parameter DBInstanceName is not valid.', 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['errorCode' => 'Order.ComboInstanceNotAllowOperate', 'errorMessage' => 'A package instance is not allowed to operate independently.', 'description' => 'A package instance is not allowed to operate independently.'],
['errorCode' => 'Price.PricingPlanResultNotFound', 'errorMessage' => 'Pricing plan price result not found.', 'description' => 'Pricing plan price result not found.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['errorCode' => 'CommodityServiceCalling.Exception', 'errorMessage' => 'Failed to call commodity service.', 'description' => 'Failed to call commodity service return.'],
['errorCode' => 'RegionDissolvedEOM', 'errorMessage' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['errorCode' => 'Commodity.InvalidComponent', 'errorMessage' => 'The module you purchased is not legal, please buy it again.', 'description' => 'The module you purchased is not legal, please buy it again.'],
['errorCode' => 'RegionEndTimeDissolvedAustralia', 'errorMessage' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'description' => 'Hello customer, this area has been abolished.'],
['errorCode' => 'Price.CommoditySys', 'errorMessage' => 'Commodity system call exception.', 'description' => 'Commodity system call exception.'],
['errorCode' => 'Pay.InsufficientBalance', 'errorMessage' => 'Insufficient available balance.', 'description' => 'Insufficient available balance.'],
['errorCode' => 'Order.PeriodInvalid', 'errorMessage' => 'There is a problem with the period you selected, please choose again.', 'description' => 'There is a problem with the period you selected, please choose again.'],
['errorCode' => 'pay.noCreditCard', 'errorMessage' => 'Account not bound to credit card.', 'description' => ''],
['errorCode' => 'Order.InstHasUnpaidOrder', 'errorMessage' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['errorCode' => 'noAvailablePaymentMethod', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['errorCode' => 'BasicInfoUncompleted', 'errorMessage' => 'Your information is incomplete. Complete your information before the operation.', 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['errorCode' => 'Risk.RiskControlRejection', 'errorMessage' => 'Your account is abnormal, please contact customer service for details.', 'description' => 'Your account is abnormal, please contact customer service for details.'],
['errorCode' => 'Api.NotSupport', 'errorMessage' => 'Specified api is not supported.', 'description' => 'The current interface does not support.'],
['errorCode' => 'ContainForbiddenLabelError', 'errorMessage' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in records.', 'description' => 'The DBInstanceId provided does not exist.'],
['errorCode' => 'InvalidInstanceLevel.DiskType', 'errorMessage' => 'Specified instance level not support request disk type', 'description' => 'The current instance type does not support the specified storage type.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['errorCode' => 'KmsApiError', 'errorMessage' => 'User secret key invalid.', 'description' => 'The user key is invalid.'],
['errorCode' => 'System.SaleValidateFailed', 'errorMessage' => 'Sales expression validation system error.', 'description' => 'A system error occurs when the sales expression is verified.'],
['errorCode' => 'Abs.InvalidAccount.NotFound', 'errorMessage' => 'account is not found.', 'description' => 'The account does not exist.'],
['errorCode' => 'SqlExecuteFailedOrTimeout', 'errorMessage' => 'sql command execution failed or timed out:%s.', 'description' => 'SQL command execution failed or timed out'],
['errorCode' => 'ColdData.EngineVersionNotSupport', 'errorMessage' => 'The current instance engine version not support coldDataEnabled.', 'description' => 'The current instance engine version not support coldDataEnabled.'],
['errorCode' => 'ColdData.MinorVersionNotSupport', 'errorMessage' => 'The current instance minor version not support coldDataEnabled.', 'description' => 'The current instance minor version not support coldDataEnabled.'],
['errorCode' => 'IncorrectTargetClasscode', 'errorMessage' => 'The current instance type does not support this operation.', 'description' => 'This operation is not supported by the instance type.'],
['errorCode' => 'InvalidConnectionString.Duplicate', 'errorMessage' => 'Specified connection string already exists in the RDS.', 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => ''],
['errorCode' => 'Parameters.Invalid', 'errorMessage' => 'Parameter error, please check the parameters.', 'description' => 'Parameter error, please check the parameters.'],
['errorCode' => 'BackupPolicyNotSupport', 'errorMessage' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['errorCode' => 'InvalideStatus.Format', 'errorMessage' => 'The instance status does not support this operation.', 'description' => ''],
['errorCode' => 'InvalidReleasedKeepPolicy.Format', 'errorMessage' => 'Specified Released Keep Policy is not valid.', 'description' => 'Specified Released Keep Policy is not valid.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
['errorCode' => 'Pay.NoCreditCard', 'errorMessage' => 'No credit cards.', 'description' => 'No credit cards.'],
['errorCode' => 'VpcNetworkTypeNotSupport', 'errorMessage' => 'The vpc network type instance does not support this operation.', 'description' => 'The vpc network type instance does not support this operation.'],
['errorCode' => 'MirrorInsExists', 'errorMessage' => 'Specified DB instance mirror ins already existed.', 'description' => 'Specified DB instance mirror ins already existed.'],
['errorCode' => 'UnsupportedClassCode', 'errorMessage' => 'The specified DB instance class stops selling.', 'description' => 'The specified DB instance class stops selling.'],
['errorCode' => 'InvalidBackupSet', 'errorMessage' => 'The specified database does not exist in the backup set.', 'description' => 'The specified database does not exist in the backup set.'],
['errorCode' => 'OrdTCommodityQueryError', 'errorMessage' => 'Failed to query for product.', 'description' => 'Failed to query product.'],
['errorCode' => 'ProductInstanceReleased', 'errorMessage' => 'The instance has been released. Please check before placing the order.', 'description' => 'The instance has been released, please verify and place an order.'],
['errorCode' => 'RegionEndTimeDissolvedIndia', 'errorMessage' => 'The region is no longer supported.', 'description' => 'The region is no longer supported.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'The proxy instance has not been activated.', 'description' => ''],
['errorCode' => 'OrderStatus.UnPaid', 'errorMessage' => 'The specified db instance has unpaid order.', 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['errorCode' => 'InvalidReduceDiskSize', 'errorMessage' => 'The storage capacity after the scale-down must be larger than the used amount.', 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['errorCode' => 'CloudSSDNotSupport', 'errorMessage' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'description' => ''],
['errorCode' => 'InvalidUserOperatorPermission', 'errorMessage' => 'The user permission does not support this operation.', 'description' => 'The user is not authorized to perform this operation.'],
['errorCode' => 'InvalidVswitchId', 'errorMessage' => 'Specified conn vswitch id is not valid.', 'description' => ''],
['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'This operation is not supported for the current minor engine version.'],
['errorCode' => 'OperationDenied.ZoneResource', 'errorMessage' => 'There is no available zone for inventory.', 'description' => 'There is no available zone for inventory.'],
['errorCode' => 'NotInFlowController', 'errorMessage' => 'Sorry,no permission.', 'description' => 'Sorry,no permission.'],
['errorCode' => 'InvalidKmsKey', 'errorMessage' => 'Kms key is disabled.', 'description' => ''],
['errorCode' => 'InvalidInstanceLevel.Malformed', 'errorMessage' => 'Current DB instance level does not support this operation.', 'description' => 'The specified database instance type does not support this operation.'],
],
[
['errorCode' => 'AllocateResourceFailed', 'errorMessage' => 'Failed to allocate resources. Please check the zone and the host you selected.', 'description' => 'Failed to obtain the requested resources. Check whether the zone and the host can provide sufficient resources for the instance type that you specify.'],
['errorCode' => 'InvalidParam', 'errorMessage' => 'The parameter is invalid.', 'description' => 'The operation failed. The values of some parameters are invalid.'],
['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'The target availability zone does not have sufficient resources.', 'description' => 'The target Availability Zone does not have enough resources.'],
['errorCode' => 'InvalidClusterKms', 'errorMessage' => 'The current instance does not authorized to access the Key Management Service.', 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['errorCode' => 'Request.NotFound', 'errorMessage' => 'The requested resource is not available.', 'description' => 'The requested resources are unavailable.'],
],
500 => [
['errorCode' => 'ExternalFailure', 'errorMessage' => 'The request processing has failed due to external service failure.', 'description' => 'The request processing has failed due to external service failure.'],
['errorCode' => 'RequestMetaDataFailed', 'errorMessage' => 'The service request failed. Please try again later or contact service personnel.', 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['errorCode' => 'InvokeProxyFailure', 'errorMessage' => 'The request processing has failed due to service failure of rds api.', 'description' => 'The request failed to be processed due to an RDS API failure.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBInstanceName\\": \\"bu9****\\",\\n \\"RequestId\\": \\"44537EC8-DFA2-4745-B579-E733FF2C5B9A\\",\\n \\"TaskId\\": \\"334362871\\"\\n}","type":"json"}]',
'title' => 'UpgradeDBProxyInstanceKernelVersion',
'description' => '### Applicable engines'."\n"
."\n"
.'- RDS MySQL'."\n"
."\n"
.'- RDS PostgreSQL'."\n"
."\n"
.'### Related features'."\n"
."\n"
.'>'."\n"
."\n"
.'Before you call this API, carefully read the related feature documentation. Ensure you understand the prerequisites and effects of this operation.'."\n"
."\n"
.'>'."\n"
."\n"
.'- [Upgrade the minor kernel version of the database proxy for RDS MySQL](~~197465~~)'."\n"
."\n"
.'- [Upgrade the minor kernel version of the database proxy for RDS PostgreSQL](~~418469~~)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-09T11:20:55.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-12-19T11:02:14.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2023-04-17T07:50:57.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-06-08T11:55:51.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBProxyInstanceKernelVersion'],
],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'rds:UpgradeDBProxyInstanceKernelVersion',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'rds:ResourceTag', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'],
],
],
],
],
],
'ValidateImportTask' => [
'summary' => 'Runs a precheck on a data import task for an RDS for MySQL instance that uses native replication.',
'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' => 'The region ID. You can call the `DescribeRegions` operation to retrieve the latest list of available regions.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'Host',
'in' => 'query',
'schema' => ['description' => 'The address of the source MySQL instance.', 'type' => 'string', 'required' => true, 'example' => '192.168.10.1', 'title' => ''],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => 'The port number of the source MySQL instance.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65536', 'minimum' => '1', 'example' => '3306', 'title' => ''],
],
[
'name' => 'StreamPort',
'in' => 'query',
'schema' => ['description' => 'The port used for backup data transmission.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '9999', 'title' => ''],
],
[
'name' => 'User',
'in' => 'query',
'schema' => ['description' => 'The user account for the source MySQL instance.', 'type' => 'string', 'required' => true, 'example' => 'myadmin', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The password for the specified user account. The password must be Base64-encoded.', 'type' => 'string', 'required' => true, 'example' => 'UGFzc3dvcmQxMjMK', 'title' => ''],
],
[
'name' => 'SourcePlatform',
'in' => 'query',
'schema' => [
'description' => 'The platform type of the source instance.'."\n"
."\n"
.'- Set the value to `ECS`.',
'type' => 'string',
'enum' => ['ECS', 'RdsCustom'],
'required' => false,
'example' => 'ECS',
'title' => '',
],
],
[
'name' => 'SourceInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9ff3acy500io5wdf5s', 'title' => ''],
],
[
'name' => 'XtrabackupPath',
'in' => 'query',
'schema' => ['description' => 'The path to the Xtrabackup tool on the source instance.', 'type' => 'string', 'required' => false, 'example' => '/usr/local/bin/xtrabackup', 'title' => ''],
],
[
'name' => 'DbInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the destination RDS instance. You can call the `DescribeDBInstances` operation to query for available instances.', 'type' => 'string', 'required' => true, 'example' => 'rm-sdfljk123****', 'title' => ''],
],
[
'name' => 'EstimatedSize',
'in' => 'query',
'schema' => ['description' => 'The estimated data size of the source instance, in GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '',
'title' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '08A3B71B-FE08-4B03-974F-CC7EA6DB1828 '],
'TaskId' => ['description' => 'The ID of the precheck task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'."\n", 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'INVALID_SOURCE_INSTANCE.RDS_CUSTOM', 'errorMessage' => 'Source RdsCustom instance is not valid to import, please check instance attributes.', 'description' => 'The source RdsCustom instance cannot be used for RDS data import. Check the instance properties.'],
['errorCode' => 'InvalidDBInstanceEngineType.Format', 'errorMessage' => 'the DB instance engine type does not support this operation.', 'description' => 'This operation is not supported for the database engine of the instance.'],
],
403 => [
['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
],
],
'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'Rds::2014-08-15::DescribeImportTaskValidation', 'callbackInterval' => 3000, 'maxCallbackTimes' => 20],
'title' => 'Precheck for Data Import Job',
'description' => 'This operation validates the parameters and prerequisites for a data import task before you run the task.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'mysql', 'title' => '云数据库 MySQL 版'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'rds:ValidateImportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'RDS', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08A3B71B-FE08-4B03-974F-CC7EA6DB1828\\\\t\\",\\n \\"TaskId\\": 12345\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-heyuan.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'rds.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'rds-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.ap-northeast-1.aliyuncs.com', 'endpoint' => 'rds.ap-northeast-1.aliyuncs.com', 'vpc' => 'rds-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.ap-southeast-1.aliyuncs.com', 'endpoint' => 'rds.ap-southeast-1.aliyuncs.com', 'vpc' => 'rds-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.ap-southeast-3.aliyuncs.com', 'endpoint' => 'rds.ap-southeast-3.aliyuncs.com', 'vpc' => 'rds-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.ap-southeast-5.aliyuncs.com', 'endpoint' => 'rds.ap-southeast-5.aliyuncs.com', 'vpc' => 'rds-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.ap-southeast-6.aliyuncs.com', 'endpoint' => 'rds.ap-southeast-6.aliyuncs.com', 'vpc' => 'rds-vpc.ap-southeast-6.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'rds.cn-wulanchabu.aliyuncs.com', 'vpc' => 'rds-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.cn-chengdu.aliyuncs.com', 'endpoint' => 'rds.cn-chengdu.aliyuncs.com', 'vpc' => 'rds-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.cn-guangzhou.aliyuncs.com', 'endpoint' => 'rds.cn-guangzhou.aliyuncs.com', 'vpc' => 'rds-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.cn-huhehaote.aliyuncs.com', 'endpoint' => 'rds.cn-huhehaote.aliyuncs.com', 'vpc' => 'rds-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rds.eu-west-1.aliyuncs.com', 'endpoint' => 'rds.eu-west-1.aliyuncs.com', 'vpc' => 'rds-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rds.eu-central-1.aliyuncs.com', 'endpoint' => 'rds.eu-central-1.aliyuncs.com', 'vpc' => 'rds-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rds.us-east-1.aliyuncs.com', 'endpoint' => 'rds.us-east-1.aliyuncs.com', 'vpc' => 'rds-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rds.us-west-1.aliyuncs.com', 'endpoint' => 'rds.us-west-1.aliyuncs.com', 'vpc' => 'rds-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'rds.na-south-1.aliyuncs.com', 'endpoint' => 'rds.na-south-1.aliyuncs.com', 'vpc' => 'rds-vpc.na-south-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'rds.me-east-1.aliyuncs.com', 'endpoint' => 'rds.me-east-1.aliyuncs.com', 'vpc' => 'rds-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rds.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'rds.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'rds-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-beijing-finance-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'rds.aliyuncs.com', 'endpoint' => 'rds.aliyuncs.com', 'vpc' => 'rds-vpc.cn-shanghai-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'Abs.ImageNotFound', 'message' => 'The specified Image is disabled or is deleted.', 'http_code' => 400, 'description' => 'The specified image has expired or has been deleted.'],
['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'account is not found.', 'http_code' => 400, 'description' => 'The account does not exist.'],
['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'Your Alibaba Cloud account does not exist or your AccessKey has expired.', 'http_code' => 403, 'description' => 'Your Alibaba Cloud account does not exist, or your AccessKey has expired.'],
['code' => 'Abs.InvalidMaintainTime', 'message' => 'The MaintainTime parameter is invalid.', 'http_code' => 400, 'description' => 'The MaintainTime parameter is not specified or invalid.'],
['code' => 'Abs.securityIPList.Malformed', 'message' => 'securityIPList is malformed.', 'http_code' => 400, 'description' => 'The specified whitelist IP list is invalid.'],
['code' => 'AccessBlsDeniedException', 'message' => 'BLS server error. please contact customer service.', 'http_code' => 400, 'description' => 'A BLS error occurred.'],
['code' => 'AccessForbidden', 'message' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', 'http_code' => 403, 'description' => 'The specified X.509 certificate or CMS key does not exist.'],
['code' => 'AccessHDMInstanceFailed', 'message' => 'The specified instance access HDM failed.', 'http_code' => 400, 'description' => 'The RDS instance failed to connect to DAS.'],
['code' => 'Account.AddError', 'message' => 'Create Account failed, please check your input value or may your input value not satisfy instance current policy', 'http_code' => 400, 'description' => 'Failed to create the account. Check the specified parameters or the parameter policy configuration.'],
['code' => 'Account.DelError', 'message' => 'Delete Account failed, please check your input value or may your request is waiting lock in your instance.', 'http_code' => 400, 'description' => 'Failed to delete the account. Check the specified parameters or whether the request process is waiting for a lock.'],
['code' => 'Account.DelError', 'message' => '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).', 'http_code' => 400, 'description' => '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).'],
['code' => 'Account.DeleteError', 'message' => 'Failed to delete the account. Parameter values are invalid, or the request is waiting for locks.', 'http_code' => 400, 'description' => 'Failed to delete the account. Check the input parameters or check whether a process in the instance is waiting for a lock.'],
['code' => 'Account.QueryError', 'message' => 'Query Account failed, please check your input value.', 'http_code' => 400, 'description' => 'Failed to query the account, check the request parameters. For example, check whether the specified account of the RDS for MySQL instance contains special characters.'],
['code' => 'Account.UpdateError', 'message' => 'Update Account failed, please check your input value', 'http_code' => 400, 'description' => 'Failed to update the account. Check the specified parameters or the parameter policy configuration.'],
['code' => 'Account.UpdateError', 'message' => 'Account is invalid.', 'http_code' => 400, 'description' => 'The specified account number is invalid.'],
['code' => 'Account.UpdateError', 'message' => '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).', 'http_code' => 400, 'description' => '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).'],
['code' => 'AccountActionForbidden', 'message' => 'Some objects depend on account.', 'http_code' => 401, 'description' => 'Database objects depend on the account that is used to perform this operation. Remove the dependency and perform this operation again.'],
['code' => 'AccountBalanceExceeded', 'message' => 'User attempted to create a new order.but user account balance is insufficient.', 'http_code' => 400, 'description' => 'The balance of your Alibaba Cloud account is insufficient. You cannot create a new order. Top up or add funds to your Alibaba Cloud account.'],
['code' => 'AccountBasicInfoUncompleted', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your information is incomplete. Complete your information and try again.'],
['code' => 'AccountExistArrearage', 'message' => 'Your Account cannot buy the resources because of an arrearage bill.', 'http_code' => 404, 'description' => 'Your Alibaba Cloud account has overdue payments. Add funds to your Alibaba Cloud account and try again.'],
['code' => 'AccountLeastAssociateOneDB', 'message' => 'Retain at least one account in a DB.', 'http_code' => 400, 'description' => 'At least one authorized account must be retained for the database.'],
['code' => 'AccountLimitExceeded', 'message' => 'AccountQuotaExceeded: Exceeding the allowed amount of account.', 'http_code' => 403, 'description' => 'The maximum number of accounts has been exceeded. Only one high-privilege account is allowed to be created in MySQL, and the number of ordinary accounts can be multiple.'],
['code' => 'AccountLimitExceeded', 'message' => 'AccountQuotaExceeded: Exceeding the allowed amount of account', 'http_code' => 403, 'description' => 'The number of accounts exceeds the maximum number of accounts that are allowed.'],
['code' => 'AccountMoneyValidate.error', 'message' => 'Insufficient funds available in the account.', 'http_code' => 400, 'description' => 'The available balance of the account is insufficient.'],
['code' => 'AccountMoneyValidateError', 'message' => 'The available amount of the account is insufficient.', 'http_code' => 400, 'description' => 'The available balance of the account is insufficient.'],
['code' => 'AccountQueryPriceFault', 'message' => 'The account not refer to the correct order price. please contact customer service.', 'http_code' => 403, 'description' => 'The account did not reference the correct order price. Please contact customer service.'],
['code' => 'AclLimitExceed', 'message' => 'The number of security group rules for the NIC or instance exceeds the limit.', 'http_code' => 403, 'description' => 'The number of security group rules for the NIC or instance exceeds the limit.'],
['code' => 'ActionUnauthorized', 'message' => 'The specified action is not available for you.', 'http_code' => 403, 'description' => 'The operation is not supported.'],
['code' => 'ActivityNotFound', 'message' => 'Activity not found', 'http_code' => 500, 'description' => 'The activity does not exist.'],
['code' => 'ADInstanceNotSupportThisOperation', 'message' => 'The AD instance is not supported this operation', 'http_code' => 400, 'description' => 'This operation is not supported for instances that have been joined to an AD domain.'],
['code' => 'AliCroup2CloudUserCannotBuyNotInnerCommodity', 'message' => 'There is no group cloud commodity label, and users within the group are not allowed to purchase.', 'http_code' => 403, 'description' => 'The product does not have the required tag for group cloud migration. Internal group users are not allowed to purchase this product.'],
['code' => 'AllocateResourceFailed', 'message' => 'Failed to allocate resources. Please check the zone and the host you selected.', 'http_code' => 404, 'description' => 'Failed to obtain the requested resources. Check whether the zone and the host can provide sufficient resources for the instance type that you specify.'],
['code' => 'AnalyticInstanceAlreadyExists', 'message' => 'The mysql instance already has an associated clickhouse instance.', 'http_code' => 400, 'description' => 'MySQL already has an associated Clickhouse instance.'],
['code' => 'AnalyticInstanceRelationNotFound', 'message' => 'The clickhouse instance has no relation with custins.', 'http_code' => 400, 'description' => 'The Clickhouse is not associated with the current instance.'],
['code' => 'Api.NotSupport', 'message' => 'Specified api is not supported.', 'http_code' => 400, 'description' => 'The current interface does not support.'],
['code' => 'APICallingFailed', 'message' => 'Api calling failed.', 'http_code' => 400, 'description' => 'An internal error occurred.'],
['code' => 'APICallingFailed', 'message' => 'Meta db calling failed.', 'http_code' => 400, 'description' => 'An internal error occurred.'],
['code' => 'APICallingFailed', 'message' => 'Api called failed, please check vpc vsw vip', 'http_code' => 400, 'description' => 'The API call failed. Check the VPC, vSwitch, VIP, and other parameters.'],
['code' => 'ApiInvokeTimeout', 'message' => 'Internal service call timeout, please try again later', 'http_code' => 403, 'description' => 'An internal service timeout error occurred. Please try again later.'],
['code' => 'ARMNotSupport', 'message' => 'ARM arch does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported on the ARM architecture.'],
['code' => 'ArrearageOrderExists', 'message' => 'Your account has an outstanding balance.', 'http_code' => 400, 'description' => 'Add funds to your Alibaba Cloud account, complete the overdue payments, and then try again.'],
['code' => 'ArrearageOrderExists', 'message' => 'The user account had arrearage.', 'http_code' => 404, 'description' => 'The balance of your Alibaba Cloud account is insufficient. Top up or add funds to your Alibaba Cloud account.'],
['code' => 'ArticleNotFound', 'message' => 'Article not found', 'http_code' => 400, 'description' => 'No relevant constraints are found.'],
['code' => 'AssociatedEcsSecurityGroupIdQuotaExceed', 'message' => 'Security groups quota exceeded', 'http_code' => 400, 'description' => 'The operation failed. The number of security groups that are configured for the RDS instance exceeds the quota.'],
['code' => 'AtLeastOneBackupParamExists', 'message' => 'The specified params(BackupId or RestoreTime or BackupFile) at least one.', 'http_code' => 403, 'description' => 'The operation failed. Specify at least one of the following parameters: backupid, restoretime, or BackupFile.'],
['code' => 'AtLeastOneCollationTimeZoneParamExists', 'message' => 'The specified params(Collation or Timezone) at least one.', 'http_code' => 404, 'description' => 'At least one of the collation and the time zone must be specified.'],
['code' => 'AtLeastOneNetTypeExists', 'message' => 'You must specify at least one network type for the instance.', 'http_code' => 400, 'description' => ' '],
['code' => 'AtLeastOneNetTypeExists', 'message' => 'The current database instance network type does not support the operation', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'AtLeastOneNetTypeExists', 'message' => 'The specified network type at least one.', 'http_code' => 404, 'description' => 'The network type must be specified.'],
['code' => 'AtLeastThreeVSwitchAvailableIp', 'message' => 'The primary vswitch requires at least three available IP addresses.', 'http_code' => 400, 'description' => 'The master switch requires at least 3 available IPs.'],
['code' => 'AtLeastTwoVSwitchAvailableIp', 'message' => 'The primary vswitch requires at least two available IP addresses.', 'http_code' => 400, 'description' => 'The master switch requires at least 2 available IPs.'],
['code' => 'AtLeastTwoVSwitchParamExists', 'message' => 'The specified params(Vswitchs) at least two.', 'http_code' => 400, 'description' => 'At least two Vswitchs parameters must be specified. Each Vswitchs parameter specifies a vSwitch in a zone.'],
['code' => 'BabelfishEnabled', 'message' => 'Instances with Babelfish enabled do not allow this operation.', 'http_code' => 400, 'description' => 'Instances with Babelfish enabled do not support this behavior'],
['code' => 'Backend.Timeout', 'message' => 'The request processing has failed due to timeout of backend service,please submit a ticket.', 'http_code' => 500, 'description' => 'Background call timeout, please submit work order.'],
['code' => 'BackupEncryptCreateKeyError', 'message' => 'An error occurred while backup encryption was creating a service key.', 'http_code' => 400, 'description' => 'An incorrect key is specified for backup encryption.'],
['code' => 'BackupEncryptUnsupportCallerType', 'message' => 'backup encrypt caller type not support.', 'http_code' => 400, 'description' => 'The account type does not support backup encryption.'],
['code' => 'BackupFileDataSizeExceededFault', 'message' => 'the backup file data size is larger than the instance storage size.', 'http_code' => 400, 'description' => 'The size of backup data is larger than that of the instance storage.'],
['code' => 'BackupFilesExceeded', 'message' => 'Too many backup files were supplied. This task type only support one full backup file.', 'http_code' => 404, 'description' => 'This type of task supports only a full backup file.'],
['code' => 'BackupGetAkError', 'message' => 'An error occurred while backing up the access key.', 'http_code' => 400, 'description' => 'The AccessKey pair for the backup is incorrect.'],
['code' => 'BackupIdOrRestoreTimeNotExistFault', 'message' => 'You can not create temp instance when you does not input backupId or restoreTime params.', 'http_code' => 400, 'description' => 'You cannot create a temporary instance when you do not enter backupId or restoreTime parameters.'],
['code' => 'BackupJobExists', 'message' => 'A backup job already exists in the specified DB instance.', 'http_code' => 400, 'description' => 'The backup has been created.'],
['code' => 'BackupPolicyNotSupport', 'message' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.', 'http_code' => 400, 'description' => 'Cold Data won\'t open with CrossBackup or Flash Backup, please check Backup Policy.'],
['code' => 'BackupPropertyNotFound', 'message' => 'The backup policy is not found.', 'http_code' => 400, 'description' => 'The operation failed. The backup policy cannot be found.'],
['code' => 'BackupPropertyNotFound', 'message' => 'Backup policy not found', 'http_code' => 400, 'description' => 'The operation failed. The backup policy cannot be found.'],
['code' => 'BackupReadInstanceModifyNotAllowed', 'message' => 'The Specified Backup Read Instance cannot be modified.', 'http_code' => 400, 'description' => 'Configuration modification is not allowed because the current instance is a read-only instance.'],
['code' => 'BackupReadInstanceModifyNotAllowed', 'message' => 'Modify Backup Read Instance Is Not Allowed.', 'http_code' => 400, 'description' => 'You are not allowed to modify the instance from which the backup comes.'],
['code' => 'BackupRestoreNotSupported.BasicHA', 'message' => 'Basic instances cannot be restored to high availability instances, and high availability instances cannot be restored to basic instances.', 'http_code' => 400, 'description' => 'You cannot restore data from an RDS instance in the Basic Edition to an RDS instance in the High-availability Edition and vice versa.'],
['code' => 'BackupRestoreNotSupported.HADedicatedAlwaysOn', 'message' => 'High availability instances cannot be restored to dedicated cluster instances or AlwaysOn instances.', 'http_code' => 400, 'description' => 'The operation failed. The data of an RDS instance that runs the RDS High-availability Edition cannot be restored to an RDS instance that is deployed in a dedicated cluster or runs the RDS Enterprise Edition.'],
['code' => 'BackupRestoreNotSupported.ShareDedicatedAlwaysOn', 'message' => 'Shared instances cannot be restored to dedicated cluster instances, AlwaysOn instances, or high availability instances.', 'http_code' => 400, 'description' => 'A shared instance cannot be restored to a dedicated cluster instance, an Enterprise Edition cluster instance, or a High-availability Edition instance.'],
['code' => 'BackupType.NotSupport', 'message' => 'the specified backup type not support', 'http_code' => 400, 'description' => 'This operation is not supported for the specified backup type.'],
['code' => 'BakFileSizeExceeded', 'message' => 'Exceeding the allowed backup file size.', 'http_code' => 400, 'description' => 'Backup file size exceeds allowed value.'],
['code' => 'BakFilesNeeded', 'message' => 'Backup file does not supply.', 'http_code' => 404, 'description' => 'The backup file is not provided.'],
['code' => 'Balance.Failed', 'message' => 'The quota of amount.', 'http_code' => 404, 'description' => 'The total number exceeds the quota.'],
['code' => 'BasicCategoryNotSupport', 'message' => 'The Basic category is not supported.', 'http_code' => 403, 'description' => 'Basic series not supported'],
['code' => 'BasicInfoUncompleted', 'message' => 'Your information is incomplete, Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your basic information is incomplete. Complete your basic information before performing this operation.'],
['code' => 'BasicInfoUncompleted', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your basic information is not complete, please complete your basic information before operation.'],
['code' => 'BASIC_CATEGORY_NOT_SUPPORTED', 'message' => 'Instance cannot be basic category when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, the instance cannot be the base category.'],
['code' => 'BetaServerlessNotSupportThisAction', 'message' => 'Beta Serverless Instance Not Support This Action.', 'http_code' => 400, 'description' => 'This feature is not supported.'],
['code' => 'BetaServerlessNotSupportThisAction', 'message' => 'Beta Serverless Not Support This Feature.', 'http_code' => 403, 'description' => 'This feature is not supported.'],
['code' => 'BinlogDisableRestoreUnsupported', 'message' => 'The specified instance Disable binlog not support restore to time.', 'http_code' => 404, 'description' => 'The operation failed. The log backup feature is disabled for the RDS instance, and therefore you cannot restore the data of the RDS instance to a specified point in time.'],
['code' => 'BinlogNotFoundFault', 'message' => 'The available binlog does not exist in recovery time.', 'http_code' => 403, 'description' => 'No binlog is available for data restoration.'],
['code' => 'BlueGreenDeploymentNameCannotBeEmpty', 'message' => 'Blue green deployment name cannot be empty.', 'http_code' => 400, 'description' => 'Blue green deployment name cannot be empty'],
['code' => 'BlueGreenDeploymentRelationCannotBeEmpty', 'message' => 'Blue green deployment relation cannot be empty.', 'http_code' => 400, 'description' => 'The blu green deployment relationship of the instance does not exist.'],
['code' => 'BLUE_GREEN_DEPLOYMENT_ALREADY_EXISTS', 'message' => 'Blue-green deployment cannot exist when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, a blue-green deployment cannot already exist.'],
['code' => 'BLUE_GREEN_DEPLOYMENT_ALREADY_EXISTS', 'message' => 'Blue green deployment already exists.', 'http_code' => 400, 'description' => 'Blue green deployment already exists'],
['code' => 'BothEmpty.TagsAndResources', 'message' => 'The specified Tags and ResourcesIds are not allow to both empty.', 'http_code' => 400, 'description' => 'The operation failed. The tag and the resource ID cannot be left unspecified at the same time.'],
['code' => 'BurstingEnabledForDiskCategoryUnsupported', 'message' => 'The specified disk category does not support bursting enabled.', 'http_code' => 400, 'description' => 'The specified disk type does not support enabling the performance burst feature.'],
['code' => 'BurstingEnabledForModifyingDiskUnsupported', 'message' => 'The modifying disk does not support bursting enabled.', 'http_code' => 400, 'description' => 'Disks in the transition configuration are not allowed to modify the burst property.'],
['code' => 'BurstingEnabledForMultiAttachDiskUnsupported', 'message' => 'The multi attach disk does not support bursting enabled.', 'http_code' => 400, 'description' => 'Multi-mount disks do not support the performance burst feature.'],
['code' => 'BurstResourceStillExists', 'message' => 'The instance does not support to disable compute burst because of having burst resource.', 'http_code' => 400, 'description' => 'The instance has bursty resources and does not support shutting down committed serverless.'],
['code' => 'BYOKCertExpired', 'message' => 'The certificate has exceeded the validity period.', 'http_code' => 400, 'description' => 'The certificate has expired.'],
['code' => 'ByokInsnameAndRegionAllEmpty', 'message' => 'The insName and targetRegionId can\'t be all empty.', 'http_code' => 403, 'description' => 'The instance name and region cannot both be empty.'],
['code' => 'BYOKInstanceNotSupportThisOperation', 'message' => 'The BYOK instance is not supported this operation', 'http_code' => 400, 'description' => 'This operation is not supported for instances that have disk encryption enabled.'],
['code' => 'ByokShowParamEmpty', 'message' => 'The params:dbType can\'t be empty.', 'http_code' => 403, 'description' => 'Parameter dbType cannot be empty.'],
['code' => 'BYOLInstanceNotSupportThisOperation', 'message' => 'The BYOL instance is not supported this operation', 'http_code' => 400, 'description' => 'This operation is not supported for instances that are created from BYOL images.'],
['code' => 'CallEcsApi.Failure', 'message' => 'Fail to call ECS API.', 'http_code' => 400, 'description' => 'Failed to call the ECS api.'],
['code' => 'Caller.NotSupport', 'message' => 'The Caller Not Support This Operation .', 'http_code' => 400, 'description' => 'This operation is not supported for the caller.'],
['code' => 'CallLxSdkFailed', 'message' => 'Error calling the order system, please try again later or contact service personnel.', 'http_code' => 500, 'description' => 'Error calling the order system, please try again later or contact service personnel.'],
['code' => 'CallRdsCustomApi.Failure', 'message' => 'Failed to call rds custom api.', 'http_code' => 400, 'description' => 'Failed to call RDS-Custom Api'],
['code' => 'CannotChangeStorageType', 'message' => 'Temp upgrade does not support changing storage type.', 'http_code' => 400, 'description' => 'Elastic upgrade cannot change the storage type.'],
['code' => 'CannotChangeStorageTypeForDHGWhenUpgrade', 'message' => 'CannotChangeStorageTypeForDHGWhenUpgrade', 'http_code' => 400, 'description' => 'You cannot change the storage type of an RDS instance that is equipped with standard SSDs or ESSDs and is deployed in a dedicated cluster.'],
['code' => 'CannotChangeStorageTypeWhenUpgrade', 'message' => 'can not change storage type when modify instanceClass or storageSize.', 'http_code' => 400, 'description' => 'You cannot change the storage type when you modify the instance type or storage size.'],
['code' => 'CanNotCopyDBHasTDEEnabled', 'message' => 'The source database has enabled the TDE feature. You cannot copy it to another instance.', 'http_code' => 400, 'description' => 'TDE is enabled for the source RDS instance. Therefore, the data of the source RDS instance cannot be replicated to a different RDS instance.'],
['code' => 'CannotDecreaseEssdPerfLevel', 'message' => 'The disk specification cannot be decreased.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for standard SSDs or ESSDs.'],
['code' => 'CannotDecreaseEssdPerfLevel', 'message' => 'cannot decrease cloud essd performance level.', 'http_code' => 400, 'description' => 'The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs.'],
['code' => 'CannotDecreaseEssdPerfLevel', 'message' => 'invalid cloud essd storage size.', 'http_code' => 400, 'description' => 'The storage capacity is invalid for ESSDs.'],
['code' => 'CanNotFindSubscription', 'message' => 'Ordering information not found.', 'http_code' => 400, 'description' => 'The subscription information cannot be found.'],
['code' => 'canNotFindSubscription', 'message' => 'Subscription information not found.', 'http_code' => 404, 'description' => ''],
['code' => 'CASH.BOOK.INSUFFICIENT', 'message' => '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.', 'http_code' => 403, 'description' => 'The account does not specify a payment method.'],
['code' => 'CDDC.AvailableHostsNotEnough', 'message' => 'The number of available hosts is insufficient.', 'http_code' => 400, 'description' => 'The destination zone does not have sufficient host resources. Create a host in the zone.'],
['code' => 'CDDC.AvailableHostsNotEnoughInZone', 'message' => 'Not enough available hosts are in the target zone.', 'http_code' => 400, 'description' => 'The destination zone does not have sufficient host resources. Create a host in the zone.'],
['code' => 'CDDC.AvailableHostsNotEnoughInZone', 'message' => 'Not enough hosts are available in the target zone.', 'http_code' => 400, 'description' => 'Insufficient hosts in the zone. Create hosts in the zone.'],
['code' => 'CDDC.TargetHostIDNotAvailable', 'message' => 'The target host ID is not available.', 'http_code' => 400, 'description' => 'The host is unavailable. Specify a different host.'],
['code' => 'Certified', 'message' => 'No real name authentication.', 'http_code' => 400, 'description' => 'Real-name verification is required for pay-as-you-go RDS instances. If the RDS instance is charged based on the pay-as-you-go billing method and you have not completed real-name verification, we recommend that you immediately complete real-name verification.'],
['code' => 'CertOrPrivateKeyOrPasswordNotMatched', 'message' => 'The public certificate, private key, and password do not match.', 'http_code' => 400, 'description' => 'The password of the private key in the certificate failed the verification check.'],
['code' => 'ChangeEngineVersionNotSupported', 'message' => 'This operation does not support modifying the engine version.', 'http_code' => 400, 'description' => 'You cannot modify the major engine version during this operation.'],
['code' => 'ChargeTypeViolation', 'message' => 'The operation is not permitted due to charge type of the instance.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is a pay-as-you-go instance and cannot be renewed. Change the billing method of the RDS instance to subscription.'],
['code' => 'CheckAllowMajorVersionUpgradeFailed', 'message' => '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.', 'http_code' => 400, 'description' => 'We 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, set the parameter allowMajorVersionUpgrade to true.'],
['code' => 'ChildDBInstanceExists', 'message' => 'The specified DBInstance has a child DBInstance so it does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported because the current instance has child instances.'],
['code' => 'ChildDBInstanceExists', 'message' => 'Current DB instance had child instance.', 'http_code' => 403, 'description' => 'The read-only instance already exists.'],
['code' => 'ChildDBInstanceNotSupport', 'message' => 'Child instance does not support this operation.', 'http_code' => 403, 'description' => 'The sub-instance does not support this operation.'],
['code' => 'ClassicNetDisabled', 'message' => 'The classic network address is currently disabled, and the instance cannot perform configuration changes.', 'http_code' => 400, 'description' => 'The classic network address is currently disabled and the instance cannot perform configuration changes.'],
['code' => 'ClassicNetworkType.NotSupport', 'message' => 'The Classic instance network create is not supported.', 'http_code' => 403, 'description' => 'The operation is not supported by the classic network.'],
['code' => 'ClassicNetworkType.NotSupport', 'message' => 'The Classic networkType is not supported.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance cannot be deployed in the classic network. Change the network type to VPC.'],
['code' => 'ClassicNetworkType.NotSupport', 'message' => 'The Classic instance network create is not support.', 'http_code' => 403, 'description' => 'The current instance cannot be deployed in the classic network. Change the network type to VPC.'],
['code' => 'ClassicNetworkTypeInstanceNotSupported', 'message' => 'The classic network dbInstance is not support.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the classic network type.'],
['code' => 'CLIENT.CLIENT.UNSUPPORTED_ENGINE_TYPE', 'message' => 'The current database version does not support creating instances. Please select instance of a different database version.', 'http_code' => 400, 'description' => 'Disaster recovery instances cannot be created for the database engine version of the current instance. Specify a different database engine version.'],
['code' => 'CLIENT.CREATE_BACKUP_JOB_ERROR', 'message' => 'CLIENT.CREATE_BACKUP_JOB_ERROR', 'http_code' => 400, 'description' => 'Failed to create a disaster recovery RDS instance. The RDS instance for which you want to create a disaster recovery RDS instance is being backed up. Try again after the backup is complete.'],
['code' => 'CLIENT.DST_INST_SAME_AS_SRC_INST', 'message' => 'The DB instance is not in a valid state.', 'http_code' => 400, 'description' => 'A server error occurred. Please try again later.'],
['code' => 'CLIENT.GENERAL_ERROR', 'message' => 'SERVER.PRODUCT_TEMPLATE_NOT_FOUND', 'http_code' => 400, 'description' => 'A server error occurred. Please try again later.'],
['code' => 'CLIENT.INSTANCE_ID_NOT_FOUND', 'message' => 'CLIENT.INSTANCE_ID_NOT_FOUND', 'http_code' => 404, 'description' => 'The source instance is not found. Check the source instance.'],
['code' => 'CLIENT.MISSING_REQUIRED_PARAM', 'message' => 'CLIENT.MISSING_REQUIRED_PARAM', 'http_code' => 400, 'description' => 'The RDS instance is unavailable. Please try again later.'],
['code' => 'CLIENT.UNPROCESSABLE_ENTITY', 'message' => 'The server is out of service. Please try again later.', 'http_code' => 400, 'description' => 'A network error occurred. Please try again later.'],
['code' => 'CLIENT.UNSUPPORTED_PRODUCT', 'message' => 'The current database product does not support creating disaster recovery instances. Please select another database product.', 'http_code' => 400, 'description' => 'Disaster recovery instances cannot be created for the current instance.'],
['code' => 'CLIENT.WRONG_STATUS', 'message' => 'The DB instance is not in a valid state.', 'http_code' => 400, 'description' => 'A server error occurred. Please try again later.'],
['code' => 'CLIENT.WRONG_STATUS_STATUS', 'message' => 'The DB instance is not in a valid state.', 'http_code' => 400, 'description' => 'Failed to create a disaster recovery instance because the primary instance is not in the running state. Please try again later.'],
['code' => 'CloudboxInstanceNotSupport', 'message' => 'Cloud-box instance does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for instances in cloud boxes.'],
['code' => 'CloudDiskEncryptionNotSupport', 'message' => 'The encryption key is not allowed for general-purpose instance.', 'http_code' => 403, 'description' => 'Universal instances do not support cloud disk encryption.'],
['code' => 'CloudSSDNotSupport', 'message' => 'Cloud ssd does not support this operation, please upgrade to essd.', 'http_code' => 403, 'description' => 'SSD cloud disks do not support this operation. Upgrade to ESSD.'],
['code' => 'CLOUD_DISK_ENCRYPTION_NOT_ALLOWED', 'message' => 'CloudDisk-encryption cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, the cloud disk encryption function cannot be enabled.'],
['code' => 'ClusterEndpoint.StatusNotValid', 'message' => 'The cluster endpoint status is invalid.', 'http_code' => 400, 'description' => 'The status of the endpoint is invalid.'],
['code' => 'ClusterNotSupport', 'message' => 'ClusterNotSupport', 'http_code' => 403, 'description' => 'The operation is not supported for the RDS instance.'],
['code' => 'ClusterTypeError', 'message' => 'The Custins cluster type encounters an error. Standard cluster is not supported.', 'http_code' => 400, 'description' => 'The Custins cluster type is invalid. Only the user cluster type is supported.'],
['code' => 'ClusterTypeError', 'message' => 'Custins Cluster Type Error, Support User Cluster', 'http_code' => 403, 'description' => 'The Custins cluster type is invalid. Only the user cluster type is supported.'],
['code' => 'ClusterTypeNotSupported', 'message' => 'The current Instance ClusterType does not support this operation.', 'http_code' => 403, 'description' => 'The cluster where the current instance resides does not support this operation.'],
['code' => 'CLUSTER_CATEGORY_NOT_SUPPORTED', 'message' => 'Instance cannot be cluster category when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'The instance cannot be of the cluster category when creating a blue-green deployment.'],
['code' => 'CmdContent.DecodeError', 'message' => 'The CommandContent can not be base64 decoded.', 'http_code' => 400, 'description' => 'The command content cannot be base64 decoded.'],
['code' => 'CmdContent.ExceedLimit', 'message' => 'The length of the command content exceeds the upper limit.', 'http_code' => 403, 'description' => 'The command content length exceeds the upper limit.'],
['code' => 'CmdCount.ExceedQuota', 'message' => 'The total number of commands in the current region exceeds the quota.', 'http_code' => 403, 'description' => 'The number of cloud assistant commands in the current region has exceeded the limit.'],
['code' => 'CmdDesc.ExceedLimit', 'message' => 'The length of the command description exceeds the upper limit.', 'http_code' => 403, 'description' => 'The command description length exceeds the upper limit.'],
['code' => 'CmdName.ExceedLimit', 'message' => 'The length of the command name exceeds the upper limit.', 'http_code' => 403, 'description' => 'The command name length exceeds the upper limit.'],
['code' => 'CmdParam.EmptyKey', 'message' => 'Command parameters can not be empty.', 'http_code' => 400, 'description' => 'Custom command parameters cannot be empty.'],
['code' => 'CmdParam.InvalidParamName', 'message' => 'A command parameter name is invalid.', 'http_code' => 400, 'description' => 'A custom command parameter name is invalid.'],
['code' => 'CmdParamCount.ExceedLimit', 'message' => 'You\'ve reached the limit on the count of command parameters.', 'http_code' => 403, 'description' => 'You have reached the limit for the command parameter count.'],
['code' => 'CmdParamName.ExceedLimit', 'message' => 'The length of the command parameter name exceeds the limit.', 'http_code' => 403, 'description' => 'The length of the custom parameter name in the command exceeds the upper limit.'],
['code' => 'ColdData.EngineVersionNotSupport', 'message' => 'The current instance engine version not support coldDataEnabled.', 'http_code' => 400, 'description' => 'The current instance engine version not support coldDataEnabled.'],
['code' => 'ColdData.MinorVersionNotSupport', 'message' => 'The current instance minor version not support coldDataEnabled.', 'http_code' => 400, 'description' => 'The current instance minor version not support coldDataEnabled.'],
['code' => 'ColdDataEnabled', 'message' => 'Instances with cold data enabled do not allow this operation.', 'http_code' => 400, 'description' => 'This operation is not allowed on cold data-enabled instances.'],
['code' => 'ColdDBHasSameNameWithOnlineDB', 'message' => 'The instance has cold db and online db with the same name.', 'http_code' => 400, 'description' => 'The instance has cold db and online db with the same name.'],
['code' => 'ColdDBNumExceedsLimit', 'message' => 'the number of cold db exceeds the limit.', 'http_code' => 400, 'description' => 'The number of cold db exceeds the limit'],
['code' => 'COLD_DATA_ARCHIVING_NOT_ALLOWED', 'message' => 'Cold-data Archiving cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, the cold storage archive feature cannot be enabled.'],
['code' => 'ColumnEncryptionErrorCode.NOT_PURCHASED', 'message' => 'The instance has not enabled the column encryption service.', 'http_code' => 400, 'description' => 'Column encryption is not enabled for this instance.'],
['code' => 'COLUMN_ENCRYPTION_NOT_ALLOWED', 'message' => 'Column-encryption cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, column encryption cannot be enabled.'],
['code' => 'CommandTypeError', 'message' => 'CommandType is empty or unsupported.', 'http_code' => 400, 'description' => 'Command type is empty or not supported'],
['code' => 'COMMODITY.FAILED', 'message' => 'The commodity is error.', 'http_code' => 403, 'description' => 'A server error occurred. Contact O&M engineers.'],
['code' => 'Commodity.InvalidComponent', 'message' => 'The module you purchased is not legal, please buy it again.', 'http_code' => 400, 'description' => 'The module you purchased is not legal, please buy it again.'],
['code' => 'COMMODITYCODE.ValueNotSupported', 'message' => 'The Specified parameter CommodityCode is not valid.', 'http_code' => 403, 'description' => 'The type of the commodity is invalid.'],
['code' => 'CommodityCodeNotFound', 'message' => 'CommodityCodeNotFound', 'http_code' => 400, 'description' => 'The specified parameter CommodityCode is invalid. Please check again.'],
['code' => 'CommodityServiceCalling.Exception', 'message' => 'Failed to call commodity service.', 'http_code' => 400, 'description' => 'Failed to call commodity service return.'],
['code' => 'Concurrent.Operation', 'message' => 'System concurrent operate.', 'http_code' => 400, 'description' => 'User generated concurrent operations occurred.'],
['code' => 'ConcurrentLimit', 'message' => 'The request processing has been concurrent limit.', 'http_code' => 400, 'description' => 'Request processing has reached the concurrency limit.'],
['code' => 'ConcurrentTaskExceeded', 'message' => 'Concurrent task exceeding the allowed amount.', 'http_code' => 403, 'description' => 'The number of concurrent tasks exceeds the maximum number of concurrent tasks that are allowed.'],
['code' => 'ConflictingDatabaseOperation', 'message' => 'There is already some operation on the database and the current operation should wait till it is done.', 'http_code' => 409, 'description' => 'A database property modification is in progress for the current database.'],
['code' => 'Connect.Timeout', 'message' => 'The service cannot connect to the instance.', 'http_code' => 400, 'description' => 'The connection to the RDS instance failed. Please try again later.'],
['code' => 'Connect.Timeout', 'message' => 'Service can not connect to instance temporarily.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance cannot be connected. Please try again later.'],
['code' => 'Connect.Timeout', 'message' => 'Check connectivity timeout', 'http_code' => 400, 'description' => 'Connectivity Check Timeout'],
['code' => 'ConnectionModeNotSupported', 'message' => 'ConnectionMode specified cannot be replicate with the source DB Instance.', 'http_code' => 400, 'description' => 'The operation failed. The connection mode that is specified by the ConnectionMode parameter cannot be replicated with the original RDS instance.'],
['code' => 'ConnectionNotFound', 'message' => 'The connection is not found.', 'http_code' => 403, 'description' => 'The operation failed. The connection cannot be found.'],
['code' => 'ConnectionStringConflictFault', 'message' => 'the Specified connection string conflict', 'http_code' => 403, 'description' => 'The connection string has a conflict.'],
['code' => 'ConnectionStringContainChineseCharacterFault', 'message' => 'The connection string can not contain some chinese character.', 'http_code' => 400, 'description' => 'The connection string cannot contain certain Chinese characters.'],
['code' => 'ConnectionStringContainIllegalCharacterFault', 'message' => 'The connection string contain Illegal character.', 'http_code' => 400, 'description' => 'The endpoint contains invalid characters. Modify the endpoint and try again.'],
['code' => 'ConnectionStringLengthExceeded', 'message' => 'The specified connection string is too long.', 'http_code' => 404, 'description' => 'The endpoint is exceedingly long. Modify the endpoint.'],
['code' => 'ConnectionStringLengthExceeded', 'message' => 'Connection String is too long.', 'http_code' => 403, 'description' => 'The endpoint is exceedingly long. Modify the endpoint and try again.'],
['code' => 'ConnectTimeoutRetryLater', 'message' => 'Connect timeout retry later.', 'http_code' => 400, 'description' => 'The connection timed out. Please try again later.'],
['code' => 'ConsoleNeedLogin', 'message' => 'Login has timed out. Please login again.', 'http_code' => 400, 'description' => 'The logon timed out. Please try again later.'],
['code' => 'ContainForbiddenLabel.error', 'message' => 'There is a label that prohibits placing an order, and the order cannot be placed.', 'http_code' => 400, 'description' => 'An order-blocking tag exists. The order cannot be placed.'],
['code' => 'ContainForbiddenLabelError', 'message' => 'There is a label that prohibits placing orders. Please contact your distributor for assistance.', 'http_code' => 400, 'description' => 'You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.'],
['code' => 'CouponExist', 'message' => 'Voucher collection has reached the upper limit, and the system has recalculated the optimal price.', 'http_code' => 400, 'description' => 'You have reached the maximum number of coupons. The price is being recalculated.'],
['code' => 'CouponExist', 'message' => 'Coupon applied already, please enter a new one', 'http_code' => 500, 'description' => 'The coupon claim limit has been reached. The system has recalculated the optimal price.'],
['code' => 'CouponOverMaxRelease', 'message' => 'The given coupon is over max limit', 'http_code' => 500, 'description' => 'All coupons have been claimed. The system has recalculated the optimal price.'],
['code' => 'CreateBackupJobAlreadyExists', 'message' => 'The source DBInstanceId is backuping,unable to create guard instance.', 'http_code' => 400, 'description' => 'Failed to create a disaster recovery RDS instance. The RDS instance for which you want to create a disaster recovery RDS instance is being backed up.'],
['code' => 'CreateCouponError', 'message' => 'Error creating coupon for order', 'http_code' => 500, 'description' => 'The coupon-based order failed. The system has recalculated the optimal price.'],
['code' => 'CreateOrder.Failed', 'message' => 'The instance order is error.', 'http_code' => 400, 'description' => 'An order error occurred.'],
['code' => 'CreateOrder.Failed', 'message' => 'Create Order Failed.', 'http_code' => 404, 'description' => 'Failed to create the purchase order.'],
['code' => 'CreateOrder.Failed', 'message' => 'order failed.', 'http_code' => 404, 'description' => 'Failed to create the purchase order.'],
['code' => 'CreateRCSnapshot.Failed', 'message' => 'The process of creating RC snapshot is failed.', 'http_code' => 400, 'description' => 'Failed to create RC snapshot.'],
['code' => 'CreateSnapshot.Failed', 'message' => 'The process of creating rc snapshot is failed.', 'http_code' => 403, 'description' => 'Snapshot creation failed.'],
['code' => 'CreateUpgradeOrderBusinessException', 'message' => 'The parameter is illegal or empty.', 'http_code' => 400, 'description' => 'The parameter is illegal or empty.'],
['code' => 'CreatingCloneInsExceeded', 'message' => 'The Too many clone ins is in creating.', 'http_code' => 404, 'description' => 'The operation failed. An exceedingly large number of RDS instances are being cloned.'],
['code' => 'CreditPayInsufficientBalance', 'message' => 'Insufficient credit pay limit. Please contact your channel partner to increase the limit.', 'http_code' => 400, 'description' => 'The quota runs out. Contact your customer service representatives to increase the quota.'],
['code' => 'CrossBackup.NotSupport', 'message' => 'Specified region not support cross region backup.', 'http_code' => 403, 'description' => 'Cross-zone backup is not supported in the specified region.'],
['code' => 'CrossBackupNotSupport', 'message' => 'Specified region not support cross region backup.', 'http_code' => 403, 'description' => 'Cross-zone backup is not supported in the specified region.'],
['code' => 'CrossBackupStrategyNotSupport', 'message' => 'Cross region backup strategy is not supported.', 'http_code' => 403, 'description' => 'Cross region backup strategy is not supported.'],
['code' => 'CrossRegionUnsupportTDE', 'message' => 'Cross-region disaster restore not support TDE bakset.', 'http_code' => 400, 'description' => 'Cross-region disaster recovery does not support TDE backup sets.'],
['code' => 'CurrentDBIsInColdStorage', 'message' => 'current db is cold db.', 'http_code' => 400, 'description' => 'The current db is a cold db'],
['code' => 'CurrentInsHasColdDB', 'message' => 'The current instance has cold storage db.', 'http_code' => 400, 'description' => 'The current instance has cold storage db. '],
['code' => 'CurrentInsHasColdStorage', 'message' => 'Current instance has cold storage.', 'http_code' => 400, 'description' => 'The current instance has cold storage enabled.'],
['code' => 'CurrentOperationInSameRegion', 'message' => 'You can operation only different availability region.', 'http_code' => 403, 'description' => 'The operation failed. You can migrate the RDS instance only to a different region.'],
['code' => 'CurrentRecoveryModelNotSupportThisAction', 'message' => 'Current recovery model not supported this action.', 'http_code' => 403, 'description' => 'The current recovery model does not support.'],
['code' => 'Database.AddError', 'message' => 'Create Db failed, please check input value and instance status.', 'http_code' => 400, 'description' => 'Failed to create the database. Check the specified parameters and the instance status.'],
['code' => 'Database.ConnectError', 'message' => 'Database connect error. please check instance status and database processlist', 'http_code' => 400, 'description' => 'A database connection error occurred. Check the instance state and the database connection pool.'],
['code' => 'Database.DelError', 'message' => 'Failed to delete the database. Check the specified parameters and the instance state.', 'http_code' => 400, 'description' => 'Failed to delete the database. Check the specified parameters and the instance status.'],
['code' => 'Database.QueryError', 'message' => 'Query Db failed, please check input value and instance status.', 'http_code' => 400, 'description' => 'Failed to query the database. Check the specified parameters and the instance state.'],
['code' => 'Database.QueryError', 'message' => 'invalid value, may include special character.', 'http_code' => 400, 'description' => 'The value is invalid and may contain special characters.'],
['code' => 'Database.UpdateError', 'message' => 'Update Db failed, please check input value and instance status.', 'http_code' => 400, 'description' => 'Failed to update the database. Check the specified parameters and the instance state.'],
['code' => 'DatabaseMustOnline', 'message' => 'Database must be taken online when task type is 0 or 1.', 'http_code' => 400, 'description' => 'The database must be connected if the task type is 0 or 1.'],
['code' => 'DatabasePropertyModificationFail', 'message' => '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.', 'http_code' => 400, 'description' => 'Failed to modify the database property. This may be due to a high database workload or the inability to acquire an exclusive lock. Try modifying the property during a low-workload period.'],
['code' => 'DataNotExist', 'message' => 'Data not exist.', 'http_code' => 400, 'description' => 'No data is available.'],
['code' => 'DBClusterAlreadyExistsFault', 'message' => 'User already has ReadDBInstance with the given identifier.', 'http_code' => 403, 'description' => 'The read-only RDS instance has been marked.'],
['code' => 'DBClusterNotSupported', 'message' => 'The requested operation can not be performed while the cluster is not sale.', 'http_code' => 403, 'description' => 'The requested operation cannot be performed while the cluster is not running.'],
['code' => 'DBCountLimitExceeded', 'message' => 'Db count limit exceeded.', 'http_code' => 400, 'description' => 'The number of databases is exceeded.'],
['code' => 'DBInstanceIdsConflict', 'message' => 'The specified DBInstanceId and the specified TargetDBInstanceId ares same.', 'http_code' => 404, 'description' => 'The operation failed. The ID of the source RDS instance is the same as the ID of the destination RDS instance.'],
['code' => 'DBInstanceLocked', 'message' => 'The current instance lock mode does not support this operation.', 'http_code' => 404, 'description' => 'The operation failed. The RDS instance is locked.'],
['code' => 'DbInstanceNameCannotBeEmpty', 'message' => 'DB instance name cannot be empty.', 'http_code' => 400, 'description' => 'Instance name cannot be empty'],
['code' => 'DbInstanceNameMismatch', 'message' => 'The instance name does not match the relation\'s expected value.', 'http_code' => 400, 'description' => 'The current instance does not match the instance in the blue-green deployment relationship.'],
['code' => 'DBInstanceNotServerless', 'message' => 'The dbinstance is not serverless.', 'http_code' => 400, 'description' => 'The specified instance is a non-serverless instance.'],
['code' => 'DBInstanceOrderNotFinish', 'message' => 'The current instance order has not finish.', 'http_code' => 403, 'description' => 'You have unpaid orders for the RDS instance. Complete the orders and try again.'],
['code' => 'DBInstancePayTypeNotSupport', 'message' => 'Current instance PayType not support this operation or the param PayType not match current instance PayType.', 'http_code' => 400, 'description' => 'The billing method of the current instance does not support this operation, or the PayType parameter does not match the current instance.'],
['code' => 'DBInstanceStatusNotActive', 'message' => 'The status of the current instance is not active.', 'http_code' => 403, 'description' => 'The operation failed. Check the status of the RDS instance.'],
['code' => 'DBInstanceStatusNotActive', 'message' => 'Current DB instance status should be active.', 'http_code' => 403, 'description' => 'The operation failed. Check the status of the RDS instance.'],
['code' => 'DBInstanceStorageFormatFault', 'message' => 'The Specified DBInstanceStorage param format is not valid.', 'http_code' => 400, 'description' => 'The specified instance storage format is invalid.'],
['code' => 'DBInstanceStorageTypeFormatFault', 'message' => 'The specified parameter DBInstanceStorageType is not valid.', 'http_code' => 403, 'description' => 'The specified DbInstanceStorageType parameter is invalid.'],
['code' => 'DBLeastAssociateOneInstance', 'message' => 'Retain at least one DB in an instance.', 'http_code' => 400, 'description' => 'No databases are created in the current instance. Make sure that at least one database is created in the instance.'],
['code' => 'DBLimitExceeded', 'message' => 'DBQuotaExceeded: Exceeding the allowed amount of DB.', 'http_code' => 403, 'description' => 'The number of databases in the RDS instance reaches the upper limit. Delete unused databases from the RDS instance.'],
['code' => 'DBNodeFormatFault', 'message' => 'The specified parameter DBNode is malformed', 'http_code' => 400, 'description' => 'The specified dbNode parameter is invalid.'],
['code' => 'DBNodeIdIncludePrimary', 'message' => 'The specified parameter DBNodeId include primary node.', 'http_code' => 400, 'description' => 'The value of DBNodeId contains the ID of the primary node.'],
['code' => 'DBNodeIdNotExists', 'message' => 'The specified DBNodeId not exists.', 'http_code' => 400, 'description' => 'The node specified by DBNodeId does not exist.'],
['code' => 'DBNodeIdParameter.IncludePrimary', 'message' => 'The specified parameter DBNodeId include primary node.', 'http_code' => 400, 'description' => 'The parameter DBNodeId passed in contains the master node.'],
['code' => 'DBNodeIdParameter.NotExists', 'message' => 'The DBNodeId in the parameter does not exist.', 'http_code' => 400, 'description' => 'The DBNodeId in the parameter does not exist.'],
['code' => 'DBNodeIdParameterInvalid', 'message' => 'The specified parameter DBNodeId is malformed.', 'http_code' => 400, 'description' => 'The specified DBNodeId parameter is invalid.'],
['code' => 'DBNodeIdParameterNotFound', 'message' => 'The specified parameter DBNodeId is required.', 'http_code' => 400, 'description' => 'You must specify the DBNodeId parameter.'],
['code' => 'DBNodeParameter.InvalidClassCode', 'message' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', 'http_code' => 400, 'description' => 'The ClassCode configuration is invalid for the DBNode parameter.'],
['code' => 'DBNodeParameter.InvalidCombination', 'message' => 'DBNode class code combination is not valid.', 'http_code' => 400, 'description' => 'The DBNode parameter contains an invalid combination of instance specifications.'],
['code' => 'DBNodeParameter.InvalidValue', 'message' => 'The specific param DBNode is not valid.', 'http_code' => 400, 'description' => 'The specified DBNode parameter is invalid.'],
['code' => 'DBNodeParameter.NotFound', 'message' => 'The specified parameter DBNode is not valid.', 'http_code' => 400, 'description' => 'The specified DBNode parameter is invalid.'],
['code' => 'DBNodeParameter.Required', 'message' => 'The specified parameter DBNode is required.', 'http_code' => 400, 'description' => 'You must specify the DBNode parameter.'],
['code' => 'DBNodeParameter.Required', 'message' => 'The DBNode parameter is required for RDS for MySQL Cluster Edition instances.', 'http_code' => 400, 'description' => 'For an RDS MySQL cluster instance, the DBNode parameter is required.'],
['code' => 'DBNodeParameter.TooFewItems', 'message' => 'The specified parameter DBNode has too few items.', 'http_code' => 400, 'description' => 'A small number of DBNode parameter items are configured.'],
['code' => 'DBNodeParameter.TooFewItems', 'message' => 'The size of DBNode less than 2.', 'http_code' => 400, 'description' => 'The number of database nodes cannot be less than 2.'],
['code' => 'DBNodeParameter.TooFewItems', 'message' => 'You must configure at least 2 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', 'http_code' => 400, 'description' => 'For an RDS MySQL cluster instance, you must configure at least two nodes for the DBNode parameter.'],
['code' => 'DBNodeParameter.TooManyItems', 'message' => 'The specified parameter DBNode has too many items.', 'http_code' => 400, 'description' => 'A large number of DBNode parameter items are configured.'],
['code' => 'DBNodeParameter.TooManyItems', 'message' => 'You can configure up to 9 nodes in the DBNode parameter value for RDS for MySQL Cluster Edition instances.', 'http_code' => 400, 'description' => 'For an RDS MySQL cluster instance, the maximum number of nodes in the DBNode parameter is 9.'],
['code' => 'DBNodeParameterInvalidClassCode', 'message' => 'The ClassCode of the item of the specified parameter DBNode is inconsistent.', 'http_code' => 400, 'description' => 'You must specify the classCode filed in dbNode.'],
['code' => 'DBNodeParameterRequired', 'message' => 'The specified parameter DBNode is required.', 'http_code' => 400, 'description' => 'You must specify the dbNode parameter.'],
['code' => 'DBNodeParameterTooFewItems', 'message' => 'The specified parameter DBNode has too few items.', 'http_code' => 400, 'description' => 'An excessive number of nodes are deleted for dbNode.'],
['code' => 'DBNodeParameterTooManyItems', 'message' => 'The specified parameter DBNode has too many items.', 'http_code' => 400, 'description' => 'An excessive number of nodes are added for dbNode.'],
['code' => 'DBNotFoundFault', 'message' => 'The operation is not permitted due to status of the database is empty.', 'http_code' => 404, 'description' => 'The operation failed. The database is empty.'],
['code' => 'DbossGeneralError', 'message' => 'The instance is being created. Please wait.', 'http_code' => 400, 'description' => 'Instance is being created, please wait a moment. Or the RDS SQL Server account name may contain special characters.'],
['code' => 'DbRestoring', 'message' => 'Database is in restoring state.', 'http_code' => 400, 'description' => 'The database is in the restoring state.'],
['code' => 'DBS.ParamIsInValid', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter error.'],
['code' => 'DBSizeExceeded', 'message' => 'DBSizeExceeded: Exceeding the allowed DB size of DB Instance.', 'http_code' => 400, 'description' => 'The operation failed. The number of RDS instances exceeds the maximum number of RDS instances that are allowed.'],
['code' => 'DBSizeExceeded', 'message' => 'Exceeding the allowed DB size of DB instance.', 'http_code' => 403, 'description' => 'The size of the database exceeds the maximum size that is allowed.'],
['code' => 'DBTDEStateNotSupport', 'message' => 'The specified db tde state does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the setting of the TDE feature of the RDS instance.'],
['code' => 'DBTypeNotSupported', 'message' => 'The database type is not supported.', 'http_code' => 403, 'description' => 'The database engine is not supported.'],
['code' => 'DB_COUNT_ZERO_NOT_ALLOWED', 'message' => 'DB count cannot be 0 when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, the number of databases cannot be 0.'],
['code' => 'DefaultVpc.NotSupport', 'message' => 'The default VPC create is not supported.', 'http_code' => 400, 'description' => 'The operation failed. Your Alibaba Cloud account does not support the default VPC. Create a VPC and a vSwitch.'],
['code' => 'DefaultVpc.NotSupport', 'message' => 'The default vpc create is not support.', 'http_code' => 400, 'description' => ' '],
['code' => 'DefaultVpc.NotSupport', 'message' => 'The default VPC is not supported.', 'http_code' => 400, 'description' => 'The operation failed. Your Alibaba Cloud account does not support the default VPC. Create a VPC and a vSwitch.'],
['code' => 'DeleteBackupSetNumExceed', 'message' => 'Delete backup set number is more than 100.', 'http_code' => 400, 'description' => 'The number of backup sets to delete exceeds 100.'],
['code' => 'DeleteWithInstance.Conflict', 'message' => 'Multi attach disk cannot be set to DeleteWithInstance attribute.', 'http_code' => 403, 'description' => 'Cloud disks with the multi-mount feature enabled do not support setting DeleteWithInstance.'],
['code' => 'DeleteWithInstance.Conflict', 'message' => 'The specified image is from the image market, you cannot set DeleteWithInstance attribute to false.', 'http_code' => 403, 'description' => 'The specified image is from the image market and cannot be released with the instance.'],
['code' => 'DependencyViolation', 'message' => 'The operation is not permitted due to instance mount read only or guard instance.', 'http_code' => 403, 'description' => 'This operation is not supported. The RDS instance is a read-only RDS instance or a disaster recovery RDS instance.'],
['code' => 'DependencyViolation.InstanceType', 'message' => 'The current InstanceType cannot be changed to the specified InstanceType.', 'http_code' => 400, 'description' => 'The specification of the current instance cannot be changed to the specified specification.'],
['code' => 'DependencyViolation.NotEmpty', 'message' => 'There are still instance(s) in the specified DeploymentSetId.', 'http_code' => 400, 'description' => 'The specified deployment set still contains instances.'],
['code' => 'DeploymentSet.NotFound', 'message' => 'The specified deployment set does not exist.', 'http_code' => 404, 'description' => 'The specified deployment set does not exist.'],
['code' => 'DisasterRestoreRegionNotMatched', 'message' => 'Disaster restore should be operated in the ddr region or source region.', 'http_code' => 400, 'description' => 'Disaster recovery must be performed in the DDR region or the source region.'],
['code' => 'DiskCategory.OperationNotSupported', 'message' => 'The type of the specified disk does not support creating a snapshot.', 'http_code' => 403, 'description' => 'The current disk does not support this operation.'],
['code' => 'DiskNotPortable', 'message' => 'The specified disk is not a portable disk.', 'http_code' => 403, 'description' => 'The specified disk is not an unmountable disk. A disk with a Portable of false cannot be unmounted.'],
['code' => 'DiskSize.NotEnough', 'message' => 'The disk size is not enough to restore tables.', 'http_code' => 400, 'description' => 'The cloud disk does not have sufficient space.'],
['code' => 'DiskSpaceInsufficientForColdOperation', 'message' => 'Insufficient disk space to bring db online.', 'http_code' => 400, 'description' => 'Insufficient disk space to bring db online'],
['code' => 'DISK_COMPRESSION_NOT_ALLOWED', 'message' => 'Disk-compression cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'Disk compression cannot be enabled when creating a blue-green deployment.'],
['code' => 'DnsConflict', 'message' => 'A DNS conflict occurred with other customer instances.', 'http_code' => 400, 'description' => 'The DNS server conflicts with other users.'],
['code' => 'DnsConflict', 'message' => 'Dns is conflict with other custins.', 'http_code' => 404, 'description' => 'The DNS server conflicts with other clients.'],
['code' => 'DoubleWriteNotAllowed', 'message' => 'Double-write is not allowed when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, double write is not allowed.'],
['code' => 'DOUBLE_WRITE_NOT_ALLOWED', 'message' => 'Double-write is not allowed when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'The doublewrite feature is not supported when you create a blue-green deployment.'],
['code' => 'DstRegionNoUser', 'message' => 'The user info wasn\'t found destination region, please access the purchase page to initiate registration.', 'http_code' => 400, 'description' => 'Unable to find the destination area of user information, please visit the purchase page to start registration.'],
['code' => 'DtsInfoNotFound', 'message' => 'DTS info does not exist.', 'http_code' => 400, 'description' => 'DTS information does not exist.'],
['code' => 'DtsSyncDelayTooLarge', 'message' => 'DTS sync delay is too large.', 'http_code' => 400, 'description' => 'The synchronization delay of the current DTS is too high'],
['code' => 'DtsSyncStatusNotSupported', 'message' => 'DTS sync status is not supported.', 'http_code' => 400, 'description' => 'The synchronization status of the current DTS is not supported.'],
['code' => 'Duplicate.ResourceTagKey', 'message' => 'The ResourceTag contains duplicate keys.', 'http_code' => 400, 'description' => 'ResourceTag contains duplicate keys.'],
['code' => 'Duplicate.TagKey', 'message' => 'The Tag.N.Key contain duplicate key.', 'http_code' => 400, 'description' => 'The operation failed. A duplicate key is specified by the Tag.N.Key parameter.'],
['code' => 'Duplicate.TagKey', 'message' => 'The Tag.N.Key contains duplicate keys.', 'http_code' => 400, 'description' => 'The values of two Tag.N.Key parameters are duplicate.'],
['code' => 'EmptyEndpointNodeConfig', 'message' => 'Specified endpoint has no nodes, add node to endpoint first.', 'http_code' => 400, 'description' => 'No nodes are attached to the endpoint. Attach nodes to the endpoint first.'],
['code' => 'EnabledSSLNotSupport', 'message' => 'SSL is not supported for the service.', 'http_code' => 404, 'description' => 'The operation failed. SSL encryption is not supported.'],
['code' => 'EnabledSSLNotSupport', 'message' => 'The backend service does not support SSL.', 'http_code' => 404, 'description' => 'The backend does not support SSL encryption.'],
['code' => 'EnabledSSLNotSupport', 'message' => 'You cannot enable SSL in the specified region.', 'http_code' => 404, 'description' => 'The operation failed. SSL encryption is not supported in the region.'],
['code' => 'EnabledSSLNotSupport', 'message' => 'Specified region does not support enable ssl.', 'http_code' => 404, 'description' => 'SSL encryption is not supported in the region.'],
['code' => 'EncryptionInstancesNotSupport', 'message' => 'Cloud disk encryption instances that use byok do not support modify to multi tenant.', 'http_code' => 400, 'description' => 'Cloud disk encryption instances that use custom keys do not support changing configuration to general-purpose specifications.'],
['code' => 'EncryptionKeyNotSupport', 'message' => 'The encryption key is not support to generate encryption disk.', 'http_code' => 403, 'description' => 'This key does not support creating cloud disk encryption instances.'],
['code' => 'Endpoint.NotFound', 'message' => 'The specified endpoint is not found.', 'http_code' => 404, 'description' => 'The target endpoint does not exist.'],
['code' => 'Endpoint.NotFound', 'message' => 'Specified endpoint is not found.', 'http_code' => 404, 'description' => 'The port that is associated with the dedicated proxy endpoint cannot be found.'],
['code' => 'Endpoint.NotFound', 'message' => 'The specified EndPoint is not valid.', 'http_code' => 400, 'description' => 'The specified proxy terminal does not exist.'],
['code' => 'Endpoint.NotFound', 'message' => 'Specified endpoint is not existed.', 'http_code' => 404, 'description' => 'The target endpoint does not exist.'],
['code' => 'EndpointConfig.Invalid', 'message' => 'Please check the endpoint config parameter.', 'http_code' => 404, 'description' => 'Please check the endpoint configuration parameter.'],
['code' => 'EndpointNum.Error', 'message' => 'The number of endpoint is invalid.', 'http_code' => 400, 'description' => 'The number of proxy terminals is not supported. Check the maximum number of proxy terminals that are allowed.'],
['code' => 'EndpointNum.Error', 'message' => 'Endpoint number error.', 'http_code' => 400, 'description' => 'The number of endpoints has reached the upper limit. No more endpoints can be created.'],
['code' => 'EndpointNum.Error', 'message' => 'The number of endpoint is too many.', 'http_code' => 400, 'description' => 'The number of endpoints has reached the upper limit. No more endpoints can be created.'],
['code' => 'EndpointType.NotFound', 'message' => 'The specified endpoint type is not found.', 'http_code' => 404, 'description' => 'The operation failed. Unknown types of proxy terminals are detected.'],
['code' => 'EndpointType.NotSupport', 'message' => 'Current db type is not support specified endpoint type.', 'http_code' => 400, 'description' => 'The specified endpoint type is invalid.'],
['code' => 'EndpointTypeOperation.NotSupport', 'message' => 'The endpoint type does not support the operation.', 'http_code' => 400, 'description' => 'The operation is not supported for the type of proxy terminal that you configure.'],
['code' => 'ENDPOINT_NOT_FOUND', 'message' => 'The source address %s must be the endpoint of source instance %s.', 'http_code' => 403, 'description' => 'Illegal source instance address'],
['code' => 'EndTimeExceededRange', 'message' => 'The EndTime is not within the service active time range.', 'http_code' => 400, 'description' => 'The end time is not within the time range that is allowed.'],
['code' => 'EngineMigration.ActionDisabled', 'message' => 'Specified action is disabled while custins is in engine migration.', 'http_code' => 400, 'description' => 'The specified operation is disabled when the instance is being migrated across engines.'],
['code' => 'EngineNotSupported', 'message' => 'Engine specified cannot be supported the operation.', 'http_code' => 400, 'description' => 'The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.'],
['code' => 'EngineNotSupported', 'message' => 'The engine does not support the operation.', 'http_code' => 400, 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['code' => 'EngineNotSupportShrinkStorage', 'message' => 'The current engine does not support shrinking storage space.', 'http_code' => 400, 'description' => 'The current engine does not support shrinking storage space.'],
['code' => 'EngineVersionNotSupported', 'message' => 'EngineVersion specified cannot be replicate with the source DB Instance.', 'http_code' => 400, 'description' => 'Instance cloning is not supported for the database engine version of the current instance.'],
['code' => 'EniPerInstanceLimitExceeded', 'message' => 'The number of elastic network interfaces attached to the instance has reached the maximum limit and no more can be attached.', 'http_code' => 403, 'description' => 'The number of ENIs attached to the instance has reached the maximum limit. You cannot attach an ENI to the instance.'],
['code' => 'EnterpriseGroupLimited.MutliGroupType', 'message' => 'The specified instance can\'t associate security group of different types.', 'http_code' => 403, 'description' => 'The specified instance cannot be added to both a common security group and an enterprise security group. You can call the DescribeSecurityGroups query to specify the type of security group.'],
['code' => 'EnterpriseGroupLimited.MutliGroupType', 'message' => 'The specified instance can not join multi SecurityGroup types.', 'http_code' => 400, 'description' => 'The specified instance cannot be added to both a common security group and an enterprise security group.'],
['code' => 'EnterpriseUpgradeVersionUnsupported', 'message' => 'Enterprise version not support version upgrade.', 'http_code' => 404, 'description' => 'The operation failed. The RDS Enterprise Edition cannot be upgraded.'],
['code' => 'EntityNotExist.Role', 'message' => 'The role not exists.', 'http_code' => 400, 'description' => 'The specified role does not exist.'],
['code' => 'EntityNotExist.Role', 'message' => 'The role not exists', 'http_code' => 400, 'description' => 'The role does not exist.'],
['code' => 'Error.%s', 'message' => 'ErrorMsg: %s.', 'http_code' => 400, 'description' => 'The request is invalid. Check the error code and error message.'],
['code' => 'ErrorMxsServiceInsNum.Error', 'message' => 'The Maxscale serviceIns num must be 1.', 'http_code' => 400, 'description' => 'The Maxscale value must be 1.'],
['code' => 'ErrorParametersConflict', 'message' => 'Parameter BackupsetID and restoretime can only exist one.', 'http_code' => 400, 'description' => 'The BackupID and restoretime parameters are mutually exclusive. Specify only one of them.'],
['code' => 'ExceedDiskSize', 'message' => 'The file size exceeding the disk size', 'http_code' => 400, 'description' => 'The size of the file exceeds the available storage space. Check the available storage space and try again.'],
['code' => 'Exceeded.BackupTimes', 'message' => 'The backup times exceeds.', 'http_code' => 403, 'description' => 'The specified BackupTimes parameter is invalid.'],
['code' => 'Exceeded.SlaveLag', 'message' => 'The slave lag exceeds.', 'http_code' => 403, 'description' => 'The amount of log backup data reaches the maximum amount that is allowed.'],
['code' => 'ExceedUploadTime', 'message' => 'Exceeding the daily upload times of this DB.', 'http_code' => 400, 'description' => 'The number of downloads on the day exceeds the maximum number of downloads that are allowed per day.'],
['code' => 'ExistBiDirectionalDtsTask', 'message' => 'Exist bi-directional synchronization dts task.', 'http_code' => 400, 'description' => 'DTS bidirectional synchronization task exists'],
['code' => 'Export.InProcess', 'message' => 'There is already a task running, please try later', 'http_code' => 403, 'description' => 'A task is running. Please try again later.'],
['code' => 'ExportLimitExceeded', 'message' => 'Export all instances more than 6 times in an hour, please try 1 hour later.', 'http_code' => 400, 'description' => 'Export all instances more than 6 times in one hour, please try again after 1 hour.'],
['code' => 'ExternalFailure', 'message' => 'The request processing has failed due to external service failure.', 'http_code' => 500, 'description' => 'The request processing has failed due to external service failure.'],
['code' => 'ExternalReplicationError', 'message' => 'The instance is not a native replicated instance.', 'http_code' => 400, 'description' => 'The instance is not a native replication instance'],
['code' => 'Failed.CreateOrderError', 'message' => 'Create order failed, please retry later.', 'http_code' => 500, 'description' => 'Create order failed, please retry later.'],
['code' => 'FileNotAvailable', 'message' => 'The specified file is not available.', 'http_code' => 400, 'description' => 'The file is unavailable.'],
['code' => 'FileNotCompleted', 'message' => 'The specified file does not upload completed.', 'http_code' => 400, 'description' => 'The file is not uploaded. Upload the file.'],
['code' => 'FileNotUploaded', 'message' => 'The specified file does not upload.', 'http_code' => 400, 'description' => 'The operation failed. The file is not uploaded. Upload the file.'],
['code' => 'FileSizeExceeded', 'message' => 'FileSizeExceeded: Exceeding the allowed file size of DB Instance.', 'http_code' => 403, 'description' => 'The file size exceeds the maximum file size that is supported for the RDS instance. Modify the file size.'],
['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'http_code' => 400, 'description' => 'The RAM user account does not have the required permissions. Grant the account the required permissions.'],
['code' => 'Forbidden.Authentication', 'message' => 'The operation is forbidden by Aliyun Realname Authentication System.', 'http_code' => 403, 'description' => 'The operation failed. The operation is prohibited by the Alibaba Cloud real-name verification system.'],
['code' => 'Forbidden.InstanceNotFound', 'message' => 'The specified instance is not found.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check that the RDS instance has not been deleted.'],
['code' => 'Forbidden.NotSupportRAM', 'message' => 'This action does not support accessed by RAM mode.', 'http_code' => 403, 'description' => 'The operation is not supported for RAM users.'],
['code' => 'Forbidden.NotSupportRAM', 'message' => 'This operation is not supported for RAM users.', 'http_code' => 403, 'description' => 'This operation is not supported for RAM users.'],
['code' => 'Forbidden.RAM', 'message' => 'User not authorized to operate on the specified resource', 'http_code' => 403, 'description' => 'The account does not have the required permissions. Check the permissions of the account.'],
['code' => 'Forbidden.RegionId', 'message' => 'The current region does not provide this service.', 'http_code' => 400, 'description' => 'The current region temporarily does not offer this service.'],
['code' => 'Forbidden.RegionNotFound', 'message' => 'The provided RegionId does not exist.', 'http_code' => 400, 'description' => 'The region ID cannot be found.'],
['code' => 'Forbidden.RegionNotFound', 'message' => 'The provided RegionId does not exist in our record.', 'http_code' => 400, 'description' => 'The operation failed. The region ID cannot be found.'],
['code' => 'Forbidden.RegionNotFound', 'message' => 'The operation is not permitted due to region of instance.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported in the region of the RDS instance.'],
['code' => 'Forbidden.RegionNotFound', 'message' => 'The provided RegionId does not exist in our record.', 'http_code' => 403, 'description' => 'The operation failed. The region ID cannot be found.'],
['code' => 'Forbidden.RiskControl', 'message' => 'This operation is forbidden by Aliyun RiskControl system.', 'http_code' => 403, 'description' => 'The operation failed. The operation is risky. Check the operation and try again.'],
['code' => 'Forbidden.RiskControl', 'message' => 'This operation is forbidden by aliyun risk control system.', 'http_code' => 403, 'description' => 'The operation failed. The operation is risky. Check the operation and try again.'],
['code' => 'Forbidden.SnapshotRecovery', 'message' => 'Snapshot backup does not support partial restore', 'http_code' => 403, 'description' => 'The operation failed. Snapshot backup files cannot be used to restore only a specific part of data.'],
['code' => 'Forbidden.SubUser', 'message' => 'Your account does not have permission to operate this resource. Please request the relevant permissions from the main account.', 'http_code' => 403, 'description' => 'Your account does not have permission to operate this resource. Please request the relevant permissions from the main account.'],
['code' => 'FTPServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the FTP server.', 'http_code' => 403, 'description' => 'The operation failed. FTP server errors occurred.'],
['code' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL', 'message' => 'There are arrears orders.', 'http_code' => 400, 'description' => 'Your account has an overdue payment. Complete the payment and try again.'],
['code' => 'FUWU_BIZ_COMMODITY_VERIFY_FAIL', 'message' => 'Your account status check has failed', 'http_code' => 404, 'description' => 'The purchase failed. Possible reasons: 1) You have not completed identity verification. 2) Your account balance is insufficient. 3) The number of instances exceeds the maximum number of instances that are allowed.'],
['code' => 'FUWU_ERROR', 'message' => 'FUWU_ERROR', 'http_code' => 400, 'description' => 'The verification failed. Failure cause: {0}".'],
['code' => 'GdnRole.NotSupport', 'message' => 'Specified gdn role is not support.', 'http_code' => 400, 'description' => 'Accounts cannot be deleted for the GDN role.'],
['code' => 'GeneralIns.Creating', 'message' => 'The general instance is creating.', 'http_code' => 400, 'description' => 'An RDS instance is in production. Please wait.'],
['code' => 'GeneralIns.Maintaining', 'message' => 'The general instance is maintaining.', 'http_code' => 400, 'description' => 'An RDS instance is being migrated or maintained. Please wait.'],
['code' => 'GeneralIns.Switching', 'message' => 'The general instance is Switching.', 'http_code' => 400, 'description' => 'A switchover for high availability is in progress. Please wait.'],
['code' => 'GeneralInstanceNotSupport', 'message' => 'The general-purpose classCode does not support cloud disk encryption. Please check your parameters.', 'http_code' => 403, 'description' => 'Universal instances do not support cloud disk encryption. Check the parameters you entered.'],
['code' => 'GetCommodity.Failed', 'message' => 'Get commodity failed.', 'http_code' => 404, 'description' => 'Failed to obtain commodity information. The value of the CommodityCode parameter is invalid. Check the value of this parameter.'],
['code' => 'GlobalReadonlyAccountMaxCountExceed', 'message' => 'The number of global read-only accounts exceeds the limit.', 'http_code' => 400, 'description' => 'The number of global read-only accounts exceeds the upper limit.'],
['code' => 'GroupPolicyNotFound', 'message' => 'The specified group policy does not exist.', 'http_code' => 400, 'description' => 'The specified group policy does not exist.'],
['code' => 'GroupReplicationNotSupport.InvalidEngineVersion', 'message' => 'Group Replication requires the instance engine version to be 8.0.', 'http_code' => 403, 'description' => 'The database engine version of the instance is not MySQL 8.0. MySQL Group Replication is not supported.'],
['code' => 'GroupReplicationNotSupport.InvalidNodeClassCode', 'message' => 'Group Replication requires the ClassCode of each node to be consistent.', 'http_code' => 403, 'description' => 'The specifications of the instance nodes are inconsistent. MySQL Group Replication is not supported.'],
['code' => 'GroupReplicationNotSupport.InvalidNodeNum', 'message' => 'Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.', 'http_code' => 403, 'description' => 'The number of instance nodes is not an odd number greater than or equal to 3. MySQL Group Replication is not supported.'],
['code' => 'GroupReplicationNotSupport.InvalidParameters', 'message' => 'Group Replication limits parameters and does not support modification.', 'http_code' => 400, 'description' => 'The group Replication has restrictions on parameters and cannot be modified.'],
['code' => 'GroupReplicationNotSupport.InvalidXengine', 'message' => 'Group Replication is not supported because the instance has xengine tables.', 'http_code' => 403, 'description' => 'The instance contains tables that use the X-Engine storage engine. MySQL Group Replication is not supported.'],
['code' => 'GroupReplicationNotSupport.MemoryTooSmall', 'message' => 'Group Replication is not supported because the memory is too small.', 'http_code' => 403, 'description' => 'The instance specification has insufficient memory. MySQL Group Replication is not supported.'],
['code' => 'GroupReplicationNotSupport.TableWithoutPrimaryKey', 'message' => 'Group Replication is not supported because the instance exists table has no primary key.', 'http_code' => 403, 'description' => 'The instance has tables without primary keys and does not support MySQL group replication (MGR).'],
['code' => 'GtidPurgedError', 'message' => 'Gtid purged is null or format is incorrect.', 'http_code' => 400, 'description' => 'gtid_purged is null or malformed.'],
['code' => 'GuardDBInstanceNotSupport', 'message' => 'Guard instance does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for disaster recovery instances.'],
['code' => 'GuardInstance.Exist', 'message' => 'The guard instance has exist.', 'http_code' => 400, 'description' => 'The disaster recovery instance already exists.'],
['code' => 'GuardInstance.ReleaseFail', 'message' => 'The guard instance release fail.', 'http_code' => 400, 'description' => 'Failed to release the protected instance.'],
['code' => 'HaConfig.Format', 'message' => 'The value of HaConfig must be auto or manual', 'http_code' => 400, 'description' => 'The value of the HASwitchConfig parameter must be Auto or Manual.'],
['code' => 'HaConfigIsNull', 'message' => 'HaConfig is null.', 'http_code' => 400, 'description' => 'The value of the HASwitchConfig parameter is null.'],
['code' => 'HaDiagnoseConfig.Format', 'message' => 'The specified parameter TcpConnectionType is invalid.', 'http_code' => 400, 'description' => 'The value of the TcpConnectionType parameter is invalid. Check the value of this parameter.'],
['code' => 'HbaItem.InvalidMethod', 'message' => 'Specified hba item auth method is invalid.', 'http_code' => 403, 'description' => 'The specified HBA identity authentication method is invalid.'],
['code' => 'HostInfo.NotFound', 'message' => 'The specified host info is not found.', 'http_code' => 404, 'description' => 'The specified host information does not exist.'],
['code' => 'HostTypeNotSupport', 'message' => 'Host type is inconsistent, please check that the original host type is the same as the target host type.', 'http_code' => 403, 'description' => 'The host type before and after the change is inconsistent. Make sure the source host type and the target host type are the same.'],
['code' => 'IcSaleBusinessFault', 'message' => 'The request not refer to the correct order sales business. please contact customer service.', 'http_code' => 400, 'description' => 'The instance specification configuration is invalid. Submit a ticket.'],
['code' => 'IdempotenceParamNotMatch', 'message' => 'The specified parameter not match.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'IdempotentParameterMismatch', 'message' => 'Arguments on this idempotent request are inconsistent with arguments used in previous request(s).', 'http_code' => 403, 'description' => 'The requested clientToken is duplicated.'],
['code' => 'IdempotentProcessing', 'message' => 'The previous idempotent request(s) is still processing.', 'http_code' => 403, 'description' => 'The previous idempotent request is still being processed, please try again later.'],
['code' => 'illegal.parameter', 'message' => 'illegal parameter, param is illegal parameter, param is com.aliyun.phoenix.api.rds.request.ModAccountPrivilegeRequest property:[accountName] is null', 'http_code' => 400, 'description' => 'You must specify the accountName parameter.'],
['code' => 'illegal.parameter', 'message' => 'illegal parameter, param is dbName param format is error.', 'http_code' => 400, 'description' => 'You must specify the dbName parameter.'],
['code' => 'IllegalParameter', 'message' => 'Illegal parameter', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'IllegalParameter', 'message' => 'illegal parameter, param is empty.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'ImageNotFound', 'message' => 'The specified Image is disabled or is deleted.', 'http_code' => 400, 'description' => 'The specified image is disabled or deleted.'],
['code' => 'IncompleteAccountInfo', 'message' => 'Your account information is incomplete. Update your information first.', 'http_code' => 400, 'description' => 'Go to the Basic Information page in Account Center and complete all information that is marked with asterisks (*).'],
['code' => 'IncompleteAccountInfo', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'The operation failed. Items that are marked with an asterisk (*) in the account information must be specified. Make sure that you specify these items on the Basic Information page in Account Center.'],
['code' => 'IncompleteParamter', 'message' => 'Some fields can not be null in this request.', 'http_code' => 400, 'description' => 'Missing parameter in request.'],
['code' => 'IncompleteTaxInfo', 'message' => 'Your tax information is incomplete. Update the information first.', 'http_code' => 400, 'description' => 'Your tax information is incomplete. Complete your tax information and try again.'],
['code' => 'IncompleteTaxInfo', 'message' => 'Your tax information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'The operation failed. Your tax information is incomplete. Complete your tax information.'],
['code' => 'InconsistentAccounts', 'message' => 'Inconsistent accounts between blue and green instances.', 'http_code' => 400, 'description' => 'The account of the blue instance is inconsistent with that of the green instance.'],
['code' => 'InconsistentDatabases', 'message' => 'Inconsistent databases between blue and green instances.', 'http_code' => 400, 'description' => 'The databases of the blue instance and the green instance are inconsistent.'],
['code' => 'InconsistentIpWhitelists', 'message' => 'Inconsistent ip whitelists between blue and green instances.', 'http_code' => 400, 'description' => 'The IP whitelists of the blue and green instances are inconsistent.'],
['code' => 'InconsistentPrivateConnections', 'message' => 'Inconsistent private connections between blue and green instances.', 'http_code' => 400, 'description' => 'Inconsistent private network links between blue and green instances'],
['code' => 'InconsistentPublicConnections', 'message' => 'Inconsistent public connections between blue and green instances.', 'http_code' => 400, 'description' => 'The public link between the blue and green instances is inconsistent.'],
['code' => 'InconsistentSecurityGroups', 'message' => 'Inconsistent security groups between blue and green instances.', 'http_code' => 400, 'description' => 'The security groups of the blue and green instances are inconsistent.'],
['code' => 'Incorrect.DBInstanceTdeStatus', 'message' => 'This operation does not support instances for which TDE is enabled.', 'http_code' => 400, 'description' => 'TDE encryption is enabled for the current instance. This operation is not supported.'],
['code' => 'Incorrect.ReadDBInstanceDisksize', 'message' => 'The disk size of the read-only instance must be equal to or greater than that of the primary instance.', 'http_code' => 400, 'description' => 'The storage capacity of a read-only instance must be greater than or equal to the storage capacity of its primary instance.'],
['code' => 'Incorrect.TargetClasscode', 'message' => 'The current instance type does not support this operation.', 'http_code' => 400, 'description' => 'This series is not supported for the time being.'],
['code' => 'IncorrectAccount', 'message' => 'Current DB instance account does not support this operation.', 'http_code' => 400, 'description' => 'The current instance account does not support this operation.'],
['code' => 'IncorrectAccountPrivilegeType', 'message' => 'the current account privilege type does not support this operation.', 'http_code' => 403, 'description' => 'The permission type of the current account does not support this operation.'],
['code' => 'IncorrectAccountStatus', 'message' => 'Current account status does not support this operation.', 'http_code' => 400, 'description' => 'The current account status does not support this operation.'],
['code' => 'IncorrectAccountType', 'message' => 'Current account type does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the current account type. Check the account type.'],
['code' => 'IncorrectBackupPolicy', 'message' => '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.', 'http_code' => 400, 'description' => '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.'],
['code' => 'IncorrectBackupSetMethod', 'message' => 'Current backup set method does not support operations.', 'http_code' => 403, 'description' => 'The operation failed. The data backup file does not support the restoration of individual databases and tables.'],
['code' => 'IncorrectBackupSetState', 'message' => 'Current backup set state does not support operations.', 'http_code' => 403, 'description' => 'The operation failed. The data backup file is not in a ready state.'],
['code' => 'IncorrectBackupSetType', 'message' => 'Backup set type should be ddr.', 'http_code' => 400, 'description' => 'The type of backup set must be DDR.'],
['code' => 'IncorrectBackupState', 'message' => 'The backup in the current status does not support operations.', 'http_code' => 400, 'description' => 'The backup state is not supported.'],
['code' => 'IncorrectBaksetVersion', 'message' => 'Current bakset version does not support operations.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the version of the data backup file.'],
['code' => 'IncorrectCategory', 'message' => 'Current Instance type does not support Category.', 'http_code' => 403, 'description' => 'The category is not supported for the specified instance type.'],
['code' => 'IncorrectCharacterType', 'message' => 'Current DB instance character type does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the character type of the instance.'],
['code' => 'IncorrectCompressType', 'message' => 'Compress Type is Invalid.', 'http_code' => 400, 'description' => 'The compression type is invalid.'],
['code' => 'IncorrectDBCLSStatus', 'message' => 'Specified DB CLS status or CLS mode mode does not support this operation.', 'http_code' => 400, 'description' => 'CLS status error.'],
['code' => 'IncorrectDBInstance', 'message' => 'The current DB instance does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['code' => 'IncorrectDBInstanceCharacterType', 'message' => 'Current DB Instance character_type does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the character type of the current instance.'],
['code' => 'IncorrectDBInstanceConnType', 'message' => 'Current DB instance conn type does not support this operation.', 'http_code' => 403, 'description' => 'The operation is not supported for the connection type of the RDS instance.'],
['code' => 'IncorrectDBInstanceEngine', 'message' => 'The DBInstance of the current engine does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'IncorrectDBInstanceEngine', 'message' => 'Current DB Instance engine does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['code' => 'IncorrectDBInstanceLockMode', 'message' => 'Current DB instance lock mode does not support this operation.', 'http_code' => 404, 'description' => 'The operation failed. The RDS instance is locked.'],
['code' => 'IncorrectDBInstanceLockMode.ValueNotSupported', 'message' => 'The Current DB instance lock mode does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is locked.'],
['code' => 'IncorrectDBInstanceNetType', 'message' => 'The database instance network type does not support the operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'IncorrectDBInstanceNetType', 'message' => 'The current database instance network type does not support the operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'IncorrectDBInstanceNetType', 'message' => 'The network type of the specified instance does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'IncorrectDBInstanceNetType', 'message' => 'Current DB instance net type does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'IncorrectDBInstanceServiceType', 'message' => 'Current DB instance top type does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The top type of the current database instance does not support this operation.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The current DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state. Please try again later.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The DBInstance is in an incorrect state so it does not support this operation.', 'http_code' => 403, 'description' => 'The current instance status does not support this operation.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The current database status does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not running.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The current database instance state does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not running.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The instance currently has other tasks in progress.', 'http_code' => 403, 'description' => 'Please try again after the existing task is completed.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The current instance state does not support this operation.', 'http_code' => 400, 'description' => 'The operation is not supported. The RDS instance is not in a ready state.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'The proxy instance has not been activated.', 'http_code' => 403, 'description' => 'The current instance status does not support this operation.'],
['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'The current instance status does not support this operation.'],
['code' => 'IncorrectDBInstanceTdeStatus', 'message' => 'This operation does not support instances for which TDE is enabled.', 'http_code' => 400, 'description' => 'TDE encryption is enabled for the current instance. This operation is not supported.'],
['code' => 'IncorrectDBInstanceType', 'message' => 'Current DB instance engine and type does not support operations.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'IncorrectDBInstanceType', 'message' => 'The database instance type does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'IncorrectDBInstanceType', 'message' => 'The current database instance type does not support the operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the database engine of the current instance.'],
['code' => 'IncorrectDBInstanceType', 'message' => 'Current DB instance type does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['code' => 'IncorrectDBInstanceType.ChildDBInstanceNotSupport', 'message' => 'The operation is not permitted due to instance type.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance cannot be cloned.'],
['code' => 'IncorrectDBSslStatus', 'message' => 'Specified DB SSLStatus does not support this operation.', 'http_code' => 400, 'description' => 'The specified database SSL status is invalid.'],
['code' => 'IncorrectDBState', 'message' => 'The current DB state does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state. For example, the RDS instance is being created or is receiving data from a migration task.'],
['code' => 'IncorrectDBType', 'message' => 'The current DB type does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported by the database engine of the RDS instance. Specify a different database engine.'],
['code' => 'IncorrectDiskStatus', 'message' => 'The operation is not supported in this status.', 'http_code' => 403, 'description' => 'The current disk does not support this operation. Please check whether the disk is in normal use and is in arrears.'],
['code' => 'IncorrectDiskStatus.CreatingSnapshot', 'message' => 'A previous snapshot creation is in process.', 'http_code' => 403, 'description' => 'A snapshot is being created for the current cloud disk. Wait until the snapshot is created and try again.'],
['code' => 'IncorrectDiskStatus.NeverAttached', 'message' => 'The specified disk has never been attached to any instance.', 'http_code' => 403, 'description' => 'The detachable cloud disk has not been attached after creation, and its content has not changed.'],
['code' => 'IncorrectEffectiveTime', 'message' => 'The specified EffectiveTime params is not valid.', 'http_code' => 403, 'description' => 'The value of the EffectiveTime parameter is invalid.'],
['code' => 'IncorrectEngineTypeMyisam', 'message' => 'Current DB instance has MyISAM table, and it does not support this operation.', 'http_code' => 403, 'description' => 'The major version of MySQL is upgraded. Check whether the instance has MyISAM engine tables.'],
['code' => 'IncorrectEngineVersion', 'message' => 'Current DB instance engine version does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['code' => 'IncorrectEngineVersion', 'message' => 'The engine version does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine version of the RDS instance.'],
['code' => 'IncorrectEngineVersion', 'message' => 'Current engine version does not support operations.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance.'],
['code' => 'IncorrectEventStatus', 'message' => 'Current event\'s status does not support this operation.', 'http_code' => 400, 'description' => 'The current event state does not support this operation.'],
['code' => 'IncorrectHostType', 'message' => 'Current DB Instance host type does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the host type of the current instance.'],
['code' => 'IncorrectInstanceNetworkType', 'message' => 'The specified parameter InstanceNetworkType is not valid.', 'http_code' => 400, 'description' => 'The InstanceNetworkType parameter is invalid.'],
['code' => 'IncorrectInstanceStatus', 'message' => 'The current status of the resource does not support this operation.', 'http_code' => 400, 'description' => 'The current status of the resource does not support this operation.'],
['code' => 'IncorrectInstanceStatus.Initializing', 'message' => 'The specified instance status does not support this operation.', 'http_code' => 400, 'description' => 'The specified instance status does not support this operation.'],
['code' => 'IncorrectInstanceStatus.NotSupportESSD', 'message' => 'The operation is not supported in this status, please reboot the instance.', 'http_code' => 403, 'description' => 'The current instance status does not support the mount operation for ESSD cloud disks.'],
['code' => 'IncorrectKindCode', 'message' => 'The current KindCode of the custins does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The environment type of the current instance is not supported. Check the instance types supported by the operation.'],
['code' => 'IncorrectKindCode', 'message' => 'Current custins kindCode does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['code' => 'IncorrectMasterDBInstanceState', 'message' => 'Master instance state does not support this operation.', 'http_code' => 400, 'description' => 'The primary instance status does not support this operation.'],
['code' => 'IncorrectMinorVersion', 'message' => 'Current engine minor version does not support operations.', 'http_code' => 403, 'description' => 'This operation is not supported for the current minor engine version.'],
['code' => 'IncorrectParameter.%s', 'message' => 'The following parameters are incorrect: %s.', 'http_code' => 400, 'description' => 'The parameter is incorrect.'],
['code' => 'IncorrectPerfFrequencyType', 'message' => 'Current DB instance does not support this perf frequency.', 'http_code' => 400, 'description' => 'The current DB instance does not support this performance frequency.'],
['code' => 'IncorrectPrimaryDBInstanceDisksize', 'message' => 'Primary instance disk size must be less than or equal to all the read instance.', 'http_code' => 500, 'description' => 'The storage capacity of the primary instance must be less than or equal to that of its read-only instances.'],
['code' => 'IncorrectPrimaryDBInstanceDisksize', 'message' => 'Primary instance disk size must be less than or equal to all the read instance', 'http_code' => 400, 'description' => 'The operation failed. The storage capacity of a primary RDS instance must be less than or equal to the storage capacity of each read-only RDS instance that is attached to the primary RDS instance.'],
['code' => 'IncorrectRCInstance.Status', 'message' => 'The current status of the resource does not support this operation.', 'http_code' => 403, 'description' => 'The instance must be running or stopped.'],
['code' => 'IncorrectReadDBInstanceDisksize', 'message' => 'Read instance disk size must be equal or higher than primary instance.', 'http_code' => 403, 'description' => 'The disk size of the read-only instance must be equal to or greater than that of the primary instance.'],
['code' => 'IncorrectReadDBInstanceDisksize', 'message' => 'Incorrect read instance disk size.', 'http_code' => 400, 'description' => 'Invalid read-only instance disk size.'],
['code' => 'IncorrectReadDBInstanceMemSize', 'message' => 'The instance type of read-only instance is too small.', 'http_code' => 400, 'description' => 'The instance type of read-only instance is too small.'],
['code' => 'IncorrectReadDBInstanceState', 'message' => 'IncorrectReadDBInstanceState', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for read-only RDS instances.'],
['code' => 'IncorrectRestartMethod', 'message' => 'The specified RestartMethod params is not valid.', 'http_code' => 403, 'description' => 'The specified RestartMethod parameter is invalid.'],
['code' => 'IncorrectSQLLogActiveStatus', 'message' => 'Current DB instance SQL log active status does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is running.'],
['code' => 'IncorrectSQLLogVersion', 'message' => 'Current DB instance SQL log version does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the SQL log version of the current instance.'],
['code' => 'IncorrectStorageType', 'message' => 'Can\'t change instance storage type.', 'http_code' => 400, 'description' => 'The instance store type cannot be changed.'],
['code' => 'IncorrectTargetCategory', 'message' => 'Current target category does not support this operation.', 'http_code' => 400, 'description' => 'Current target category does not support this operation.'],
['code' => 'IncorrectTargetClasscode', 'message' => 'The current instance type does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported by the instance type.'],
['code' => 'IncorrectTaskStatus', 'message' => 'The status of certain task does not support this operation.', 'http_code' => 400, 'description' => 'A task is in a state that does not support modifying the switchover time.'],
['code' => 'IncorrectTaskType', 'message' => 'Current task does not support this operation.', 'http_code' => 400, 'description' => 'The switchover time of the task cannot be modified.'],
['code' => 'IncorrecttVpcId', 'message' => 'The specified parameter VPCId is not valid.', 'http_code' => 400, 'description' => 'The value of the VPCId parameter is invalid. Specify a valid value.'],
['code' => 'IncorrecttVpcId.Mismatch', 'message' => 'The specified parameter "VpcId " is not valid.', 'http_code' => 400, 'description' => 'The value of the VPCId parameter is invalid.'],
['code' => 'IncorrectVpcId.Mismatch', 'message' => 'The specified parameter "VpcId " is not valid.', 'http_code' => 400, 'description' => 'The VPC ID cannot be found. Check the VPC ID.'],
['code' => 'IncorrectVswitchId', 'message' => 'The specified parameter VSwitchId is not valid.', 'http_code' => 404, 'description' => 'The vSwitch ID is invalid.'],
['code' => 'IncorrectVSwitchStatus', 'message' => 'The operation is not allowed in the current VSwitch state. Expecting state includes "Created Available", but current state is "%s".', 'http_code' => 400, 'description' => 'The operation is not supported in the current state of the vSwitch.'],
['code' => 'InsName.NotFound', 'message' => 'InsName not found.', 'http_code' => 404, 'description' => 'The instance name is unknown.'],
['code' => 'InstanceAccountSameWithOsAccount', 'message' => 'The instance account name cannot be the same as the OS account name.', 'http_code' => 400, 'description' => 'The user instance account name cannot be the same as the host account name.'],
['code' => 'InstanceConnectTimeoutFault', 'message' => 'Service can not connect to instance temporarily.', 'http_code' => 400, 'description' => 'Failed to connect to the instance.'],
['code' => 'InstanceDiskNumLimitExceed', 'message' => 'The number of specified disk in an instance exceeds.', 'http_code' => 403, 'description' => 'The number of cloud disks on the instance exceeds the limit.'],
['code' => 'InstanceEngineType.NotSupport', 'message' => 'The instance engine and its type do not support the operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'InstanceEngineType.NotSupport', 'message' => 'The instance engine and type does not support operations', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine that is run on the RDS instance.'],
['code' => 'InstanceEngineType.NotSupport', 'message' => 'The instance engine and type does not support operations.', 'http_code' => 403, 'description' => 'The RDS MySQL instance engine and type do not support this operation. Check whether the instance kindcode and kernel minor version are too low and upgrade the kernel minor version.'],
['code' => 'InstanceHasReadOnlyInstanceNotSupportStop', 'message' => 'The instance has read-only instance , stop is not supported', 'http_code' => 400, 'description' => 'The instance cannot be stopped because it has a read-only instance.'],
['code' => 'InstanceHasReadOnlyInstanceNotSupportThisOperation', 'message' => 'The instance has read-only instance or is read-only instance, this operation is not supported', 'http_code' => 400, 'description' => 'This operation is not supported because this instance has read-only instances or it is a read-only instance.'],
['code' => 'InstanceIds.ExceedLimit', 'message' => 'The number of instance IDs exceeds the upper limit.', 'http_code' => 403, 'description' => 'The number of target instances exceeds the upper limit.'],
['code' => 'InstanceIsSnapshotBackupNotSupportThisOperation', 'message' => 'The instance backup method is snapshot backup, this operation is not supported', 'http_code' => 400, 'description' => 'This operation is not supported for instances that have snapshot backup enabled.'],
['code' => 'InstanceMissingMinorVersionAttr', 'message' => 'The specified instance does not have the minor_version attribute. Please contact our staff.', 'http_code' => 400, 'description' => 'The minor_version parameter is empty. Submit a ticket.'],
['code' => 'InstanceMissingMinorVersionAttr', 'message' => 'Specify instance has no minor_version attribute.', 'http_code' => 400, 'description' => 'The operation failed. The minor_version parameter is empty. Submit a ticket.'],
['code' => 'InstanceName.Failed', 'message' => 'Failed to generate instance name.', 'http_code' => 403, 'description' => 'Failed to generate the instance name.'],
['code' => 'InstanceNames.Malformed', 'message' => 'instance number of Instance Names should be less than 3000', 'http_code' => 400, 'description' => 'The operation failed. The instance name must be less than 3,000 characters in length.'],
['code' => 'InstanceNetworkTypeNotFoundFault', 'message' => 'The specified DBInstanceNetworkType is not found.', 'http_code' => 403, 'description' => 'The network type failed the verification check. The network type cannot be found.'],
['code' => 'InstanceNotSupport', 'message' => 'Instance is not support for this action.', 'http_code' => 400, 'description' => 'The instance does not support this interface.'],
['code' => 'INST_HAS_UNPAID_ORDER', 'message' => 'The instanceId has unpaid order.', 'http_code' => 403, 'description' => 'You have an unpaid order for the instance. Pay for or cancel the order and try again.'],
['code' => 'INST_HAS_UNPAID_ORDER', 'message' => 'The Account Have Not Yet Paid The Order', 'http_code' => 403, 'description' => 'Your account has an unpaid order. Pay for the order and try again.'],
['code' => 'INST_HAS_UNPAID_ORDER', 'message' => 'The specified Instance has unpaid order.', 'http_code' => 403, 'description' => 'The operation failed. You have unpaid orders for the RDS instance. Complete the orders before you proceed.'],
['code' => 'InsuffcientBalanceOrBankAccount', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['code' => 'InsuffcientBalanceOrBankAccount', 'message' => 'Add a payment method or add funds to the prepayment balance. Get started by creating an instance.', 'http_code' => 400, 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['code' => 'InsufficientAvailableQuota', 'message' => 'Your account quota limit is less than 0, please recharge before trying to purchase.', 'http_code' => 400, 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['code' => 'InsufficientBalance', 'message' => 'Your account does not have enough balance.', 'http_code' => 404, 'description' => 'Your account balance is insufficient. Add funds to your account.'],
['code' => 'INSUFFICIENTBALANCE', 'message' => 'Your account balance is insufficient.', 'http_code' => 400, 'description' => 'Your account balance is insufficient.'],
['code' => 'InsufficientCapacity', 'message' => 'There is insufficient capacity available for the requested resource.', 'http_code' => 400, 'description' => 'Insufficient resources. Please try again later.'],
['code' => 'InsufficientIpResourceCapacity', 'message' => 'Ip resource is insufficient for the requested instance.', 'http_code' => 400, 'description' => 'Insufficient IP resources for the instance.'],
['code' => 'InsufficientQuota.NoEnough', 'message' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', 'http_code' => 400, 'description' => 'The quota is insufficient. Contact your channel partner to request a quota increase.'],
['code' => 'InsufficientQuota.NotEnough', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 400, 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['code' => 'InsufficientResourceCapacity', 'message' => 'Current cluster resources are insufficient. Try again later.', 'http_code' => 404, 'description' => 'Current cluster resources are insufficient. Try again later.'],
['code' => 'InsufficientResourceCapacity', 'message' => 'No host is available for the requested instance.', 'http_code' => 404, 'description' => 'The specified zone does not have sufficient resources.'],
['code' => 'InsufficientResourceCapacity', 'message' => 'The instance cluster does not support this operation.', 'http_code' => 400, 'description' => 'The operation is not supported for the RDS instance.'],
['code' => 'InsufficientResourceCapacity', 'message' => 'The target availability zone does not have sufficient resources.', 'http_code' => 404, 'description' => 'The target Availability Zone does not have enough resources.'],
['code' => 'InsufficientResourceCapacityCheck', 'message' => 'There is insufficient capacity available for the requested instance with precheck.', 'http_code' => 400, 'description' => 'The available capacity of the instance to be prechecked is insufficient.'],
['code' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'message' => 'Your account available limit is less than 0, please recharge before trying to purchase.', 'http_code' => 400, 'description' => 'Your account available limit is less than 0, please recharge before trying to purchase.'],
['code' => 'INSUFFICIENT_BALANCE', 'message' => 'BLS server error. please contact customer service.', 'http_code' => 400, 'description' => 'The balance of your Alibaba Cloud account is less than USD 100. Top up or add funds to your Alibaba Cloud account.'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error', 'http_code' => 500, 'description' => 'An unknown error occurred while processing the request.'],
['code' => 'InternalError', 'message' => 'The request processing has failed because of an unknown error', 'http_code' => 500, 'description' => 'Please try again later. Submit a ticket.'],
['code' => 'InternalError', 'message' => 'The request processing has failed because of an unknown error, exception or failure.', 'http_code' => 500, 'description' => 'The request failed. Please try again later.'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'The request failed. Please try again later.'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'The request processing has failed due to an unknown error. Please try again.'],
['code' => 'InternalError.Dispatch', 'message' => 'An error occurred when you dispatched the request.', 'http_code' => 500, 'description' => 'An error occurred while sending the request, please try again later.'],
['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error', 'http_code' => 503, 'description' => 'An unknown error occurred while processing the request.'],
['code' => 'InternalFailure', 'message' => 'Internal failure, retry later.', 'http_code' => 400, 'description' => 'The request failed. Please try again later.'],
['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'An internal error or exception has occurred.'],
['code' => 'InternalInvokeError', 'message' => 'The request processing has failed due to some unknown error', 'http_code' => 400, 'description' => 'An unknown error occurred while processing the request.'],
['code' => 'IntranetNetTypeNotExists', 'message' => 'You need to apply for an intranet address before switching to VPC.', 'http_code' => 404, 'description' => 'Before you switch the RDS instance to a VPC, apply for a public endpoint.'],
['code' => 'IntranetNetTypeNotExists', 'message' => 'Current DB instance network type does not support this operation.', 'http_code' => 404, 'description' => 'This operation is not supported for the network type of the current instance. Change the network type of the instance.'],
['code' => 'InvaildDBInstanceClassInRegion.NotAvailable', 'message' => 'The DBInstanceClass in the Region is not available.', 'http_code' => 403, 'description' => 'The instance type is not supported. You can call the DescribeAvailableClasses operation to query the available instance types and the available storage capacity.'],
['code' => 'InvaildEngineInRegion.NotAvailable', 'message' => 'The Engine in the Region is not available.', 'http_code' => 403, 'description' => 'The database engine is not supported in the region.'],
['code' => 'InvaildEngineInRegion.NotAvailable', 'message' => 'The engine type in this region is not available.', 'http_code' => 400, 'description' => 'The database engine version is not supported in the region.'],
['code' => 'InvaildEngineInRegion.ValueNotSupported', 'message' => 'The engine is not supported in the region.', 'http_code' => 400, 'description' => 'The database engine version is invalid.'],
['code' => 'Invalid.Certificate', 'message' => 'The requested certificate parameter is invalid.', 'http_code' => 400, 'description' => 'The certificate in the request is invalid.'],
['code' => 'Invalid.DbInstanceNetType', 'message' => 'The specified parameter DbInstanceNetType is not valid.', 'http_code' => 403, 'description' => 'The network type of the RDS instance is invalid. Set the network type to Internet or Intranet.'],
['code' => 'Invalid.DestinationResource', 'message' => 'The specified DestinationResource is not valid.', 'http_code' => 404, 'description' => 'The specified destination resource is invalid.'],
['code' => 'Invalid.DestinationResource', 'message' => 'The specified destinationResource is not valid.', 'http_code' => 403, 'description' => 'The specified target resource is invalid.'],
['code' => 'Invalid.DiskFormat', 'message' => 'The specified disk is not attached to instance id.', 'http_code' => 400, 'description' => 'The cloud disk is not mounted on the instance and cannot be converted to the billing method.'],
['code' => 'Invalid.InstanceChargeType', 'message' => 'The specified InstanceChargeType is not valid.', 'http_code' => 400, 'description' => 'The specified parameter InstanceChargeType is invalid.'],
['code' => 'Invalid.InstancePayType', 'message' => 'The specified InstancePayType is not valid.', 'http_code' => 404, 'description' => 'The specified parameter InstanceChargeType is invalid.'],
['code' => 'Invalid.IoOptimized', 'message' => 'The specified IoOptimized is not valid.', 'http_code' => 404, 'description' => 'The specified parameter IoOptimized is invalid.'],
['code' => 'Invalid.NetworkCategory', 'message' => 'The specified NetworkCategory is not valid.', 'http_code' => 404, 'description' => 'The specified parameter NetworkCategory is invalid.'],
['code' => 'Invalid.NetworkType', 'message' => 'The specified NetworkType is not valid.', 'http_code' => 404, 'description' => 'The specified NetworkType is not valid.'],
['code' => 'Invalid.NextToken', 'message' => 'The parameter NextToken is invalid.', 'http_code' => 400, 'description' => 'The specified NextToken is invalid.'],
['code' => 'Invalid.OperationType', 'message' => 'The specified operationType is not valid.', 'http_code' => 403, 'description' => 'The specified parameter operationType is invalid.'],
['code' => 'Invalid.OperationType', 'message' => 'The specified OperationType is not valid.', 'http_code' => 403, 'description' => 'The specified parameter OperationType is invalid.'],
['code' => 'Invalid.Param', 'message' => 'The input parameter DestinationResource that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The destination resource type is invalid.'],
['code' => 'Invalid.Parameter', 'message' => 'Specified parameters is not valid.', 'http_code' => 403, 'description' => 'The specified parameter is invalid.'],
['code' => 'Invalid.ParamGroupDBCategory', 'message' => 'The parameter group category is basic, not standard.', 'http_code' => 400, 'description' => 'The parameter group is a basic parameter group but not a standard parameter group.'],
['code' => 'Invalid.ParamGroupDBCategory', 'message' => 'Invalid parameter group category', 'http_code' => 400, 'description' => 'The operation failed. The categories of parameter groups are invalid'],
['code' => 'Invalid.ParamGroupDBCategory', 'message' => 'ParamGroup category is basic, not standard.', 'http_code' => 400, 'description' => 'The parameter group is a basic parameter group not a standard parameter group.'],
['code' => 'Invalid.PayTypeFormat', 'message' => 'The specified PayType is not valid.', 'http_code' => 400, 'description' => 'The specified payment type is invalid.'],
['code' => 'Invalid.PeriodAndUsedTimeFormat', 'message' => 'The specified Period and UsedTime is not valid.', 'http_code' => 400, 'description' => 'When billing is a year, it cannot exceed this time.'],
['code' => 'Invalid.PrivateKey', 'message' => 'The requested privateKey parameter is invalid.', 'http_code' => 400, 'description' => 'The private key in the request is invalid.'],
['code' => 'Invalid.RCInstanceExpired', 'message' => 'The requested custom instance has expired.', 'http_code' => 400, 'description' => 'The instance has expired and the operation is not supported.'],
['code' => 'Invalid.RegionId', 'message' => 'The specified RegionId does not exist.', 'http_code' => 404, 'description' => 'The region ID is invalid.'],
['code' => 'Invalid.ResourceId', 'message' => 'The specified ResourceId is not valid.', 'http_code' => 404, 'description' => 'The specified parameter ResourceId is invalid.'],
['code' => 'Invalid.ResourceType', 'message' => 'The ResourceType provided does not exist in our records.', 'http_code' => 404, 'description' => 'The resource type is invalid.'],
['code' => 'Invalid.SpotStrategy', 'message' => 'The specified SpotStrategy is not valid.', 'http_code' => 404, 'description' => 'The spot strategy parameter is invalid.'],
['code' => 'Invalid.SpotStrategyFormat', 'message' => 'The specified SpotStrategy SpotAsPriceGo is not valid.', 'http_code' => 400, 'description' => 'Preemptible instances do not support'],
['code' => 'Invalid.UsedTimeFormat', 'message' => 'The specified UsedTime is not valid.', 'http_code' => 400, 'description' => 'The specified conversion duration is invalid'],
['code' => 'InvalidAccessKeyID.NotFound', 'message' => 'Interface call failed. Please log in again later.', 'http_code' => 400, 'description' => 'The value of the AccessKeyID parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidAccount.NotFound', 'message' => 'Invalid account is not found.', 'http_code' => 404, 'description' => 'The invalid account cannot be found.'],
['code' => 'InvalidAccountDescription.Format', 'message' => 'Specified account description is not valid.', 'http_code' => 400, 'description' => 'The account description is invalid. Specify a valid description. The description can be up to 256 characters in length and cannot be left unspecified.'],
['code' => 'InvalidAccountDescription.Malformed', 'message' => 'The specified parameter \'AccountDescription\' is not valid.', 'http_code' => 400, 'description' => 'The description of the account is invalid. The description must be 2 to 256 characters in length and can contain letters, underscores (_), hyphens (-), and digits. The description must start with a letter. The description cannot start with http:// or https://.'],
['code' => 'InvalidAccountDescription.Malformed', 'message' => 'The specified parameter AccountDescription is not valid.', 'http_code' => 400, 'description' => 'The format of the account description is invalid. It must start with letters, and must only contain letters, underscores (_), dashes (-), and numbers. It must be 2 to 256 characters in length. Note: an account description must not start with http:// or https://.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'The Security db Name is not in the available range or occupied.', 'http_code' => 400, 'description' => 'The database name is invalid. Specify a valid name.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'Specified account name already exists in this instance.', 'http_code' => 400, 'description' => 'The username already exists in the RDS instance. Specify a different username.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'Specified account already has privilege in this DB.', 'http_code' => 400, 'description' => 'The specified permissions have been granted to the account.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'Invalid AccountName specified', 'http_code' => 400, 'description' => 'The account name is invalid. Call the DescribeAccounts operation to view the list of available accounts.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'Invalid AccountName specified, duplicated.', 'http_code' => 400, 'description' => 'The account information is duplicated. Use the operation DescribeAccounts to query the list of accounts.'],
['code' => 'InvalidAccountName.Duplicate', 'message' => 'Invalid specified account name. Call the DescribeAccounts interface to view the list of accounts.', 'http_code' => 400, 'description' => 'The database name is unavailable or already in use.'],
['code' => 'InvalidAccountName.Forbid', 'message' => 'Specified account name is a keyword in RDS.', 'http_code' => 400, 'description' => 'The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.'],
['code' => 'InvalidAccountName.Format', 'message' => 'Specified account name is not valid.', 'http_code' => 400, 'description' => 'The specified account name is invalid.'],
['code' => 'InvalidAccountName.keyword', 'message' => 'The specified parameter "AccountName" is a keyword.', 'http_code' => 400, 'description' => 'The value of the AccountName parameter contains forbidden keywords. Check the value of this parameter.'],
['code' => 'InvalidAccountName.keyword', 'message' => 'The specified parameter AccountName is a keyword.', 'http_code' => 400, 'description' => 'Failed to specify the account name. The account name cannot contain the forbidden keyword AccountName. Modify the account name.'],
['code' => 'InvalidAccountName.keyword', 'message' => 'The specified parameter \'AccountName\' is a keyword.', 'http_code' => 400, 'description' => 'The value of the AccountName parameter is invalid. The value contains forbidden keywords. Modify the parameter name. For more information, see Forbidden keywords table.'],
['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountName is not valid.', 'http_code' => 400, 'description' => 'The value of the AccountName parameter is invalid. Specify a valid value.'],
['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter \'AccountName\' is not valid.', 'http_code' => 400, 'description' => 'The account description is invalid. The description can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The description must start with a lowercase letter. The description cannot contain forbidden keywords. For more information, see Forbidden keywords table.'],
['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountPassword is not valid.', 'http_code' => 400, 'description' => 'The value of the AccountPassword parameter is invalid. Specify a valid value.'],
['code' => 'InvalidAccountName.Malformed', 'message' => 'The specified parameter AccountName is not valid.', 'http_code' => 400, 'description' => 'The username is invalid. The username can contain lowercase letters, digits, and underscores (_) and must start with a lower letter and end with a lower letter or a digit. If the RDS instance runs MySQL 5.6, the username must be 2 to 16 characters in length. If the RDS instance runs MySQL 5.7 or 8.0, the username must be 2 to 32 characters in length. If the RDS instance runs SQL Server, the username must be 2 to 64 characters in length. If the RDS instance runs PostgreSQL with standard SSDs or ESSDs, the username must be 2 to 63 characters in length. If the RDS instance runs PostgreSQL with local SSDs, the username must be 2 to 16 characters in length. If the RDS instance runs MariaDB, the username must be 2 to 16 characters in length. The username cannot contain forbidden keywords. For more information, see the Forbidden keywords table.'],
['code' => 'InvalidAccountName.NotFound', 'message' => 'The specified account is not found.', 'http_code' => 404, 'description' => 'The account was not found. If you are creating an account or resetting your password, please specify your account.'],
['code' => 'InvalidAccountName.NotFound', 'message' => 'Specified account name does not exist.', 'http_code' => 404, 'description' => 'The current account name does not exist. Verify or select the correct account name.'],
['code' => 'InvalidAccountPassword.Format', 'message' => 'Specified account password is not valid.', 'http_code' => 400, 'description' => 'The password of the account is invalid. Specify a valid password.'],
['code' => 'InvalidAccountPassword.Malformed', 'message' => 'The specified parameter \'AccountPassword\' is not valid.', 'http_code' => 400, 'description' => 'The password is invalid. The password must be 6 to 32 characters in length and can contain letters, digits, and underscores (_).'],
['code' => 'InvalidAccountPassword.Malformed', 'message' => 'The specified parameter "AccountPassword" is not valid.', 'http_code' => 400, 'description' => 'The password of the account is invalid. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password can contain the following special characters:! @ # $ % ^ & * ( ) _ + - ='],
['code' => 'InvalidAccountPrivilege.Malformed', 'message' => 'Specified account privilege is not valid.', 'http_code' => 400, 'description' => 'Your account does not have the required permissions.'],
['code' => 'InvalidAccountPrivilege.ValueNotSupport', 'message' => 'The specified AccountPrivilege is not valid.', 'http_code' => 400, 'description' => 'The permissions of the account failed the verification. Check the permissions of the account.'],
['code' => 'InvalidAccountStatus.NotEnoughBalance', 'message' => 'Your account does not have enough balance.', 'http_code' => 403, 'description' => 'The balance of your Alibaba Cloud account is insufficient, top up or add funds to your Alibaba Cloud account.'],
['code' => 'InvalidAccountType.Format', 'message' => 'The first account can\'t be normal type.', 'http_code' => 400, 'description' => 'The first account can\'t be normal type.'],
['code' => 'InvalidACL.NotFound', 'message' => 'Specify acl is not found.', 'http_code' => 400, 'description' => 'The access control type is invalid.'],
['code' => 'InvalidACL.Permission', 'message' => 'Client ca certificate is set first if need to set acl.', 'http_code' => 403, 'description' => 'The operation failed. Configure the client CA certificate and try again.'],
['code' => 'InvalidAction', 'message' => 'Specified action is not valid.', 'http_code' => 400, 'description' => 'The specified action is invalid.'],
['code' => 'InvalidAction', 'message' => 'The specified action is invalid.', 'http_code' => 400, 'description' => 'The name of the operation is invalid.'],
['code' => 'InvalidAction.NotSupport', 'message' => 'The host status does not support the operation.', 'http_code' => 403, 'description' => 'The operation failed. The host is not in a ready state.'],
['code' => 'InvalidAction.NotSupport', 'message' => 'The host does not support the operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the host.'],
['code' => 'InvalidAddNodeNumber.Malformed', 'message' => 'The specified nodeNumber is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The nodeNumber parameter is empty. Specify this parameter.'],
['code' => 'InvalidADDNS.NotFound', 'message' => 'Specified ADDNS is null.', 'http_code' => 400, 'description' => 'Specified ADDNS is null.'],
['code' => 'InvalidAdDomain', 'message' => 'The name of the ad domain is invalid.', 'http_code' => 403, 'description' => 'The name of the ad domain is invalid.'],
['code' => 'InvalidAdIp', 'message' => 'The ip address of the ad domain is invalid.', 'http_code' => 403, 'description' => 'the ip address of the ad domain is invalid.'],
['code' => 'InvalidAdPassword', 'message' => 'Invalid password for ad domain.', 'http_code' => 403, 'description' => 'The password for the ad domain is invalid.'],
['code' => 'InvalidAdUserName', 'message' => 'Invalid user name for ad domain.', 'http_code' => 403, 'description' => 'The user name for the ad domain is invalid.'],
['code' => 'InvalidAllocateStrategy', 'message' => 'The Specified Allocate Strategy is not valid.', 'http_code' => 400, 'description' => 'AllocateStrategy parameter error'],
['code' => 'InvalidAvailableArea.NotFound', 'message' => 'Specified available area does not exist in RDS.', 'http_code' => 400, 'description' => 'The specified zone does not exist in ApsaraDB RDS.'],
['code' => 'InvalidAvZone.Format', 'message' => 'Specified AvZone is not valid.', 'http_code' => 400, 'description' => 'The value of the AvZone parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidAvZone.Format', 'message' => 'InvalidAvZone.Format', 'http_code' => 400, 'description' => 'The operation failed. The zone ID is invalid. Check the zone ID and try again.'],
['code' => 'InvalidAvZone.NotSupport', 'message' => 'Specified availableArea multiZone does not support in RDS.', 'http_code' => 400, 'description' => 'The specified availableArea multiZone is not supported in ApsaraDB RDS.'],
['code' => 'InvalidBackup.NotFound', 'message' => 'The available backup does not exist in recovery time.', 'http_code' => 403, 'description' => 'No available data backup file can be used to restore data.'],
['code' => 'InvalidBackupDBNames.Malformed', 'message' => 'The specified backup database is not valid.', 'http_code' => 404, 'description' => 'The operation failed. The database name is invalid.'],
['code' => 'InvalidBackupDBNames.NotFound', 'message' => 'The specified BackupDBNames is not found.', 'http_code' => 404, 'description' => 'The operation failed. The instance name is not specified.'],
['code' => 'InvalidBackupFile.Format', 'message' => 'The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid.', 'http_code' => 400, 'description' => 'The specified parameter BackupFile(BackupId, RestoreTime, or BackupFile) is invalid.'],
['code' => 'InvalidBackupFile.Malformed', 'message' => 'The specified parameter BackupFile(BackupId or RestoreTime or BackupFile) is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The format of the backup file is invalid. Check the format of the backup file.'],
['code' => 'InvalidBackupId.NotFound', 'message' => 'The specified backup does not exist.', 'http_code' => 404, 'description' => 'The backup file cannot be found. Specify an available backup file or create a backup.'],
['code' => 'InvalidBackupId.NotFound', 'message' => 'The BackupId provided does not exist.', 'http_code' => 404, 'description' => 'The data backup file cannot be found. Before you clone an RDS instance or create a temporary RDS instance, make sure that you specify an available data backup file.'],
['code' => 'InvalidBackupIdOrRestoreTime.NotFound', 'message' => 'The specified parameter BackupId or RestoreTime is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The values of the BackupId and RestoreTime parameters are invalid.'],
['code' => 'InvalidBackupLocation.Malformed', 'message' => 'The specified parameter "BackupLocation" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The value of the BackupLocation parameter is invalid. Specify a valid value.'],
['code' => 'InvalidBackupLocation.Malformed', 'message' => 'The specified parameter "BackupLocation" is not valid.', 'http_code' => 400, 'description' => 'The value of the BackupLocation parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidBackupLog.Malformed', 'message' => 'The specified parameter "backupPeriod" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. Specify a backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.'],
['code' => 'InvalidBackupLogStatus', 'message' => 'Current backup log enable status does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time.'],
['code' => 'InvalidBackupMethod.ValueNotSupport', 'message' => 'The specified parameter "BackupMethod" is not valid.', 'http_code' => 400, 'description' => 'The backup method is invalid. Specify a valid backup method. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for RDS instances in which no databases are created, and physical backups are supported only for RDS instances that run SQL Server.'],
['code' => 'InvalidBackupMethod.ValueNotSupport', 'message' => 'The specified parameter "BackupMethod" is not valid.', 'http_code' => 400, 'description' => 'The backup method is invalid. Specify a valid backup method. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for RDS instances in which no databases are created, and physical backups are supported only for RDS instances that run SQL Server.'],
['code' => 'InvalidBackupMethod.ValueNotSupport', 'message' => 'The specified parameter "BackupMethod" is not valid.', 'http_code' => 400, 'description' => 'The backup method validation failed. Valid values:'."\n"
.'- Logical: logical backup.'."\n"
.'- Physical: physical backup.'."\n"
.'Default value: Physical. Logical backup does not support instances without databases. ApsaraDB RDS for SQL Server supports only physical backup.'],
['code' => 'InvalidBackupMode.ValueNotSupport', 'message' => 'The specified parameter "BackupMode" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The backup type is invalid. Specify a valid backup type. Valid values: Automated and Manual.'],
['code' => 'InvalidBackupMode.ValueNotSupport', 'message' => 'The specified parameter "BackupMode" is not valid.', 'http_code' => 400, 'description' => 'The value of the BackupMode parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified backup retention period is invalid.', 'http_code' => 400, 'description' => 'The backup cycle is left unspecified. Specify a backup cycle in the range of 1 day to 30 days.'],
['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'Specified backup retention period is not valid.', 'http_code' => 400, 'description' => 'The backup cycle is invalid. The backup cycle must be greater than 1 day and less than or equal to 30 days.'],
['code' => 'InvalidBackupSet', 'message' => 'Specified database does not exists in the backup set.', 'http_code' => 400, 'description' => 'The specified database does not exist in the backup set.'],
['code' => 'InvalidBackupSet', 'message' => 'The specified database does not exist in the backup set.', 'http_code' => 400, 'description' => 'The specified database does not exist in the backup set.'],
['code' => 'InvalidBackupSetID', 'message' => 'Invalid backup set id.', 'http_code' => 400, 'description' => 'The backup set does not exist. You can call the DescribeBackups operation to query existing backup sets.'],
['code' => 'InvalidBackupSetID.NotFound', 'message' => 'Specified backup set ID does not exist.', 'http_code' => 404, 'description' => 'The backup set does not exist. Specify an available backup set.'],
['code' => 'InvalidBackupSetLocation.Format', 'message' => 'Specified backup set location is not valid.', 'http_code' => 400, 'description' => 'The specified backup set location is invalid.'],
['code' => 'InvalidBackupStatus.ValueNotSupport', 'message' => 'The specified parameter "BackupStatus" is not valid.', 'http_code' => 400, 'description' => 'The value of the BackupStatus parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidBackupStatus.ValueNotSupport', 'message' => 'The specified parameter "BackupStatus" is not valid.', 'http_code' => 400, 'description' => 'The status of the data backup file failed the verification check. Valid values: Success and'."\n"
.'Failed.'],
['code' => 'InvalidBackupType.Format', 'message' => 'Specified backup type is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The backup type is invalid.'],
['code' => 'InvalidBackupType.ValueNotSupport', 'message' => 'The specified parameter "BackupType" is not valid.', 'http_code' => 400, 'description' => 'The backup policy is invalid. Valid values: Auto and FullBackup. Default value: Auto. If you set the backup policy to Auto, ApsaraDB RDS automatically performs a full data backup or incremental data backup. If you set the backup policy to FullBackup, ApsaraDB RDS performs a full data backup.'],
['code' => 'InvalidBakHistory.DbVersionMismatch', 'message' => 'db version of bakhistory is mismatch with custins', 'http_code' => 400, 'description' => 'For database and table restoration, the new instance must run the same engine version as the original instance.'],
['code' => 'InvalidBakHistoryDO', 'message' => 'BakHistory is invalid when check restore TableMeta', 'http_code' => 400, 'description' => 'The operation failed. The data backup file is invalid and does not contain the data of the databases or tables.'],
['code' => 'InvalidBakset.Invalid', 'message' => 'Specified bakset is not valid.', 'http_code' => 400, 'description' => 'The specified backup set does not support this operation.'],
['code' => 'InvalidBinlog.NotFound', 'message' => 'The available binlog does not exist in recovery time.', 'http_code' => 404, 'description' => 'The binary log file at the specified point in time is invalid.'],
['code' => 'InvalidBinlogRetentionPeriod.Format', 'message' => 'Specified instance binlog retention period is not valid.', 'http_code' => 400, 'description' => 'The binary log retention period is invalid. Specify a valid binary log retention period.'],
['code' => 'InvalidBizType.Format', 'message' => 'Specified biz type is not valid.', 'http_code' => 400, 'description' => 'The current business type does not support this operation.'],
['code' => 'InvalidBurstingEnabled.DiskSizeTooSmall', 'message' => 'The disk size must be greater than 3 GiB to enable burst.', 'http_code' => 400, 'description' => 'Performance burst can only be enabled when the disk size exceeds 3GiB.'],
['code' => 'InvalidBusinessInfo.Malformed', 'message' => 'The specified parameter BusinessInfo is not valid.', 'http_code' => 400, 'description' => 'The value of the BusinessInfo parameter is invalid. Specify a valid value.'],
['code' => 'InvalidCAType.NotFound', 'message' => 'Specify ca type is not found.', 'http_code' => 400, 'description' => 'The server certificate type is invalid.'],
['code' => 'InvalidCharacter.DbOrAccount', 'message' => 'The database name or account name contains invalid characters.', 'http_code' => 400, 'description' => 'The database name or account name contains illegal characters.'],
['code' => 'InvalidCharacterSetName.Format', 'message' => 'Specified character set name is not valid.', 'http_code' => 400, 'description' => 'The character set is invalid. ApsaraDB RDS supports the following character sets: gbk, utf8, euckr, and ascii.'],
['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The deletion protection is only valid for postPaid instance, not for prePaid or spot instance.', 'http_code' => 400, 'description' => 'The delete protection function can only be used on pay-as-you-go resources.'],
['code' => 'InvalidCharsetName.ValueNotSupport', 'message' => 'The specified parameter "CharsetName" is not valid.', 'http_code' => 400, 'description' => 'The character set failed the verification check. Valid character sets:'."\n"
.'MySQL:'."\n"
.'utf8'."\n"
.'gbk'."\n"
.'latin1'."\n"
.'utf8mb4 (available only for MySQL 5.5 and MySQL 5.6)'."\n"
.'SQL Server:'."\n"
.'Chinese_PRC_CI_AS'."\n"
.'Chinese_PRC_CS_AS'."\n"
.'SQL_Latin1_General_CP1_CI_AS'."\n"
.'SQL_Latin1_General_CP1_CS_AS'."\n"
.'Chinese_PRC_BIN'],
['code' => 'InvalidCharsetName.ValueNotSupport', 'message' => 'The specified parameter \'CharsetName\' is not valid.', 'http_code' => 400, 'description' => 'The character set failed the verification check. Valid character sets:'."\n"
.'MySQL:'."\n"
.'utf8'."\n"
.'gbk'."\n"
.'latin1'."\n"
.'utf8mb4 (available only for MySQL 5.5 and MySQL 5.6)'."\n"
.'SQL Server:'."\n"
.'Chinese_PRC_CI_AS'."\n"
.'Chinese_PRC_CS_AS'."\n"
.'SQL_Latin1_General_CP1_CI_AS'."\n"
.'SQL_Latin1_General_CP1_CS_AS'."\n"
.'Chinese_PRC_BIN'],
['code' => 'InvalidClassCode', 'message' => 'The specification code in the parameter is invalid.', 'http_code' => 400, 'description' => 'The specification code in the parameter is invalid.'],
['code' => 'InvalidClassCode.NotFound', 'message' => 'Invalid ClassCode NotFound.', 'http_code' => 400, 'description' => 'The operation failed because the code of the instance type does not exist.'],
['code' => 'InvalidClassicExpiredDays', 'message' => 'The request is missing a ClassicExpiredDays parameter or parameter not between 1 ~ 120.', 'http_code' => 404, 'description' => 'The etention period is not supported by the classic network. Verify the retention policy of the classic network.'],
['code' => 'InvalidClassicExpiredDays.Malformed', 'message' => 'The specified ClassicExpiredDays is not valid.', 'http_code' => 400, 'description' => 'The retention period is not supported by the classic network. Check the retention policy of the classic network.'],
['code' => 'InvalidClassicNetworkType.NotSupport', 'message' => 'The classic network type instance does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for classic network instances.'],
['code' => 'InvalidClientCACert', 'message' => 'Specify client ca certificate is invalid.', 'http_code' => 400, 'description' => 'The client CA certificate is invalid.'],
['code' => 'InvalidClientCrl', 'message' => 'Specify client certificate revocation list is invalid.', 'http_code' => 400, 'description' => 'The client CRL is invalid.'],
['code' => 'InvalidClientCrl.Permission', 'message' => 'Client ca certificate is set first if need to set client certificate revocation list.', 'http_code' => 403, 'description' => 'The operation failed due to permission errors. Configure the client CA certificate and try again.'],
['code' => 'InvalidClientToken.Malformed', 'message' => 'The specified parameter clientToken is not valid.', 'http_code' => 400, 'description' => 'Illegal idempotent argument specified.'],
['code' => 'InvalidCloudAssistantStatus.NotInstalled', 'message' => 'The cloud assistant within the instance has not had a heartbeat in the last 2 minutes.', 'http_code' => 400, 'description' => 'The cloud assistant in the instance has not had a heartbeat in the past 2 minutes.'],
['code' => 'InvalidCloudInstanceIp.NotFound', 'message' => 'The specified cloud instance ip is not exist.', 'http_code' => 400, 'description' => 'The operation failed. The IP address cannot be found. Check the IP address.'],
['code' => 'InvalidClusterKms', 'message' => 'The current instance does not authorized to access the Key Management Service.', 'http_code' => 404, 'description' => 'The instance does not have permissions to access Key Management Service (KMS).'],
['code' => 'InvalidClusterName.NotFound', 'message' => 'The specified cluster name does not exist in the Region.', 'http_code' => 404, 'description' => 'The instance name cannot be found. Check the instance name.'],
['code' => 'InvalidClusterName.NotFound', 'message' => 'The specified cluster name is not available.', 'http_code' => 404, 'description' => 'The operation failed. The instance name cannot be found. Check the instance name and try again.'],
['code' => 'InvalidClusterResourceNotSupported', 'message' => 'You can not create the instance in the zone.', 'http_code' => 403, 'description' => 'The cluster is not found in the specified region.'],
['code' => 'InvalidClusterStatus.KubeconfigExpirationNotAllowed', 'message' => 'The expiration time of the kubeconfig is too short, please update the kubeconfig and pass in the latest kubeconfig content.', 'http_code' => 400, 'description' => 'The expiration time of the kubeconfig is too short, please update the kubeconfig and pass in the latest kubeconfig content.'],
['code' => 'InvalidCmdId.NotFound', 'message' => 'The specified command ID does not exist.', 'http_code' => 404, 'description' => 'The specified CommandId parameter is incorrect. Check whether the parameter value is correct. You can DescribeCommands query all available CommandId through the interface.'],
['code' => 'InvalidCmdType.NotFound', 'message' => 'The specified command type does not exist.', 'http_code' => 404, 'description' => 'The specified command type does not exist.'],
['code' => 'InvalidCollectStats', 'message' => 'The specified CollectStats is invalid.', 'http_code' => 400, 'description' => 'The specified CollectStats parameter is invalid.'],
['code' => 'InvalidComment', 'message' => 'Should specify a policy name.', 'http_code' => 400, 'description' => 'The name of the policy is left unspecified.'],
['code' => 'InvalidCommodityCode.Malformed', 'message' => 'The commodity code is invalid.', 'http_code' => 400, 'description' => 'The commodity code is invalid.'],
['code' => 'InvalidCommodityCode.Malformed', 'message' => 'The Specified parameter CommodityCode is not valid.', 'http_code' => 400, 'description' => 'The product code is invalid.'],
['code' => 'InvalidCommodityCode.Malformed', 'message' => 'The specified parameter \'CommodityCode\' is not valid.', 'http_code' => 403, 'description' => 'Invalid commodity code'],
['code' => 'InvalidCommodityCode.ValueNotSupported', 'message' => 'The specified parameter CommodityCode is not valid.', 'http_code' => 400, 'description' => 'The commodity code is incorrect.'],
['code' => 'InvalidConcurrentOperate', 'message' => 'Concurrent operation is detected.', 'http_code' => 400, 'description' => 'Concurrent operations exist. Wait until the previous operation is complete and try again.'],
['code' => 'InvalidCondition.Malformed', 'message' => 'The specified Condition is not valid.', 'http_code' => 400, 'description' => 'The specified condition is not valid.'],
['code' => 'InvalidCondition.Malformed', 'message' => 'The specified condition is not valid.', 'http_code' => 403, 'description' => 'The specified condition is not valid.'],
['code' => 'InvalidCondition.NotFound', 'message' => 'No class found', 'http_code' => 404, 'description' => 'The operation failed. The condition of the available class is invalid.'],
['code' => 'InvalidConfigName', 'message' => 'The ConfigName is not valid.', 'http_code' => 400, 'description' => 'The ConfigName is invalid.'],
['code' => 'InvalidConfigurationValue.Malformed', 'message' => 'Specified ConfigurationValue is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The values of some parameters are invalid.'],
['code' => 'InvalidConfigurationValueOrther.Malformed', 'message' => 'Specified ProxyConfigurationValue (check_interval_seconds or max_failed_login_attempts or blocking_seconds ) is not valid.', 'http_code' => 403, 'description' => 'The value of the ProxyConfigurationValue parameter is invalid. Check the value of this parameter before you proceed.'],
['code' => 'InvalidConfigValue', 'message' => 'The ConfigValue is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The values of some parameters are invalid.'],
['code' => 'InvalidConnectionInfo', 'message' => 'Specified ConnectionInfo is not valid.', 'http_code' => 400, 'description' => 'The specified ConnectionInfo parameter is invalid.'],
['code' => 'InvalidConnectionMode.NotSupport', 'message' => 'Current DB instance conn type does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the connection mode of the current instance.'],
['code' => 'InvalidConnectionMode.NotSupport', 'message' => 'The specified connection mode does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the connection mode of the current instance.'],
['code' => 'InvalidConnectionMode.ValueNotSupported', 'message' => 'The specified parameter "ConnectionMode" is not valid.', 'http_code' => 400, 'description' => 'The access mode failed the verification check. The value Performance specifies the standard whitelist mode. The value Safe specifies the enhanced whitelist mode.'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string already exists in the Aliyun RDS.', 'http_code' => 404, 'description' => 'The endpoint is duplicate. Specify a different endpoint.'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string or port needs to be same as current network type.', 'http_code' => 404, 'description' => 'The endpoint or port must match the current network type. Configure the endpoint or port again.'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'The specified connection string needs to be same as current network type.', 'http_code' => 400, 'description' => 'The endpoint or port must match the current network type. Configure the endpoint or port again.'],
['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string already exists in the RDS.', 'http_code' => 400, 'description' => 'The link address name is duplicate. Please reset the connection string.'],
['code' => 'InvalidConnectionString.Format', 'message' => 'Specified connection string is not valid.', 'http_code' => 400, 'description' => 'The endpoint of the RDS instance is invalid. The prefix of the endpoint must be 5 to 40 characters in length.'],
['code' => 'InvalidConnectionString.Malformed', 'message' => 'The specified parameter ConnectionStringPrefix is not valid.', 'http_code' => 400, 'description' => 'The endpoint is invalid. The endpoint must be 8 to 64 characters in length and can contain letters, digits, and hyphen (-). The endpoint cannot contain specific special characters. These special characters include ~ ! # % ^ & * = + \\ | { } ;: \'" , < > / ?'],
['code' => 'InvalidConnectionString.NotFound', 'message' => 'The specified connection string or network type is not found.', 'http_code' => 404, 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['code' => 'InvalidConnectionString.NotFound', 'message' => 'Specified connection string or net type is not found.', 'http_code' => 404, 'description' => 'The endpoint cannot be found. Check the endpoint.'],
['code' => 'InvalidConnectionString.SSL', 'message' => 'Specified connection string cannot be modified because SSL is enabled.', 'http_code' => 400, 'description' => 'Specified connection string cannot be modified because SSL is enabled.'],
['code' => 'InvalidConnectionStringOrPort.Duplicate', 'message' => 'InvalidConnectionStringOrPort.Duplicate', 'http_code' => 400, 'description' => 'The endpoint or the port number is duplicate. Modify the endpoint or the port number.'],
['code' => 'InvalidConnectionStringOrPort.Duplicate', 'message' => 'Specified connection string or port want to be modified is the same with current net type.', 'http_code' => 400, 'description' => 'The endpoint or the port number is duplicate. Modify the endpoint or the port number.'],
['code' => 'InvalidConnectionStringPrefix.Duplicated', 'message' => 'Specified connection string needs to be same as current network type.', 'http_code' => 403, 'description' => 'The specified connection string must match the current network type.'],
['code' => 'InvalidConnectionStringPrefix.Duplicated', 'message' => 'The specified connection string needs to be same as current network type.', 'http_code' => 403, 'description' => 'The specified connection string must match the current network type.'],
['code' => 'InvalidConnectionTrackingConfiguration.RegionOrUserNotSupported', 'message' => 'The specified ConnectionTrackingConfiguration parameter is not supported in this region, or this account is not on the whitelist for using network interface ConnectionTrackingConfiguration.', 'http_code' => 400, 'description' => 'Region or user does not support setting NIC connection configuration'],
['code' => 'InvalidConnVPCId', 'message' => 'Specified conn vpc id is not valid.', 'http_code' => 403, 'description' => 'The specified VPC ID is invalid.'],
['code' => 'InvalidContainerId.Malformed', 'message' => 'The specified parameter ContainerId is not valid.', 'http_code' => 400, 'description' => 'The specified container ID is invalid.'],
['code' => 'InvalidContainerName.Malformed', 'message' => 'The specified parameter ContainerName is not valid.', 'http_code' => 400, 'description' => 'The specified container name is invalid.'],
['code' => 'InvalidCreator.Malformed', 'message' => 'The specified creator is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The creator is invalid. The creator cannot be an empty string.'],
['code' => 'InvalidCrossRegionTrans', 'message' => 'Cross region instance trans is not supported', 'http_code' => 400, 'description' => 'Cross-region instance transfer is not supported.'],
['code' => 'InvalidDatabaseProperty', 'message' => 'Invalid database property.', 'http_code' => 400, 'description' => 'The name of the database property is invalid.'],
['code' => 'InvalidDatabaseProperty', 'message' => 'Specified name for the database property is not valid.', 'http_code' => 400, 'description' => 'The database property name to be modified is invalid.'],
['code' => 'InvalidDatabasePropertyValue', 'message' => 'Specified value for the database property is not valid.', 'http_code' => 400, 'description' => 'The database property value to be modified is not within the valid range.'],
['code' => 'InvalidDatabaseVersion', 'message' => 'Specified database property is not compatible with the SQL Server major version.', 'http_code' => 400, 'description' => 'The current database property is not applicable to the SQL Server major engine version.'],
['code' => 'InvalidDataDiskCategory.NotSupported', 'message' => 'Specified disk category is not supported.', 'http_code' => 400, 'description' => 'The specified cloud disk type is not supported.'],
['code' => 'InvalidDataDiskSize.ValueNotSupported', 'message' => 'The specified DataDisk.n.Size beyond the permitted range, or the capacity of snapshot exceeds the size limit of the specified disk category.', 'http_code' => 400, 'description' => 'The specified DataDisk.n.Size is outside the allowed range, or the capacity of the snapshot exceeds the size limit for the specified disk category.'],
['code' => 'InvalidDB.NotFound', 'message' => 'The specified db does not exist or DB status does not support this operation.', 'http_code' => 404, 'description' => 'The operation failed. The database cannot be found or is not running.'],
['code' => 'InvalidDB.NotFound', 'message' => 'The Specified db does not exist or DB status does not support.', 'http_code' => 404, 'description' => 'The operation failed. The database cannot be found or is not running.'],
['code' => 'InvalidDB.NotFound', 'message' => 'Specified db does not exist or DB status does not support this operation.', 'http_code' => 404, 'description' => 'The operation failed. The database cannot be found or is not in a ready state. You can call the DescribeDatabases operation to view the databases of an RDS instance.'],
['code' => 'InvalidDB.NotFound', 'message' => 'Specified db does not exist or DB status does not support.', 'http_code' => 404, 'description' => 'The specified database does not exist or the database status does not support this operation.'],
['code' => 'InvalidDBDescription.Format', 'message' => 'Specified DB description is not valid.', 'http_code' => 400, 'description' => 'The database description is invalid. Specify a valid description.'],
['code' => 'InvalidDBDescription.Malformed', 'message' => 'The specified parameter \'DBDescription\' is not valid.', 'http_code' => 400, 'description' => 'The database description failed the verification check. The description must be 2 to 256 characters in length and can contain letters, underscores (_), and hyphens (-). The description must start with a letter and cannot start with http:// or https://.'],
['code' => 'InvalidDBDescription.Malformed', 'message' => 'The specified parameter "DBDescription" is not valid.', 'http_code' => 400, 'description' => 'The value of the DBDescription parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidDBInfo.Format', 'message' => 'The specified parameter "SourceDatabaseUserName" is not valid.', 'http_code' => 400, 'description' => 'The value of the SourceDatabaseUserName parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidDBInfo.Format', 'message' => 'Specified DB info is not valid.', 'http_code' => 400, 'description' => 'The value of the DBType parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidDBInfo.Malformed', 'message' => 'The specified parameter "DBInfo" is not valid or db not exist.', 'http_code' => 400, 'description' => 'The database that you want to migrate from the RDS instance failed the verification check or cannot be found. Check whether the database is created on the RDS instance. Then, check whether a check error occurred. You can call the DescribeDatabases operation to query the details about the databases that are created on an RDS instance.'],
['code' => 'InvalidDBInfo.Malformed', 'message' => 'The specified parameter DBInfo is not valid or db not exist.', 'http_code' => 400, 'description' => 'The value of the DBInfo parameter is invalid, or the database cannot be found.'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'Your instance temporarily does not support this operation.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found or does not support this operation.'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified instance does not exist or is not supported.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check the ID or name of the RDS instance.'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'Specified instance does not exist or not support.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found, is deleted, or does not support the operation.'],
['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified instance is not found.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check the values of the request parameters.'],
['code' => 'InvalidDBInstance.ReadDBInstanceExceeded', 'message' => 'Current DB Instance exceeding the allowed amount of read instance.', 'http_code' => 404, 'description' => 'The number of read-only instances exceeds the upper limit. Adjust the number of read-only instances. A primary ApsaraDB RDS for MySQL instance with more than 64 GB memory supports a maximum of 10 read-only instances. An ApsaraDB RDS for MySQL with less than 64 GB memory supports a maximum of five read-only instances.'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'The specified instance class is not found.', 'http_code' => 400, 'description' => 'The instance type is invalid or has been discontinued. Check the instance type.'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'The Specified DB instance class is not found.', 'http_code' => 404, 'description' => 'The configuration or the instance type cannot be found or has been discontinued.'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'Specified DB instance class is not found.', 'http_code' => 404, 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'The specified instance classic does not exist.', 'http_code' => 404, 'description' => 'The configuration or the instance type cannot be found or has been discontinued. Specify a different configuration or a different instance type.'],
['code' => 'InvalidDBInstanceClass.NotSupport', 'message' => 'The target primary db instance class can not lower than the original primary db instance class.', 'http_code' => 400, 'description' => 'The target specification of the master instance must be no less than the original specification.'],
['code' => 'InvalidDBInstanceClass.NotSupported', 'message' => 'The specified parameter "DBInstanceClass" is not valid.', 'http_code' => 400, 'description' => 'The instance type is not supported. Specify a different instance type.'],
['code' => 'InvalidDBInstanceClass.Offline', 'message' => 'The specified instance type is no longer provided. Please specify another instance type.', 'http_code' => 400, 'description' => 'The instance type that you select is no longer available. Select another instance type.'],
['code' => 'InvalidDBInstanceClass.ValueNotSupported', 'message' => 'The specified parameter "DBInstanceClass" is not valid.', 'http_code' => 400, 'description' => 'The instance type of the RDS instance is invalid.'],
['code' => 'InvalidDBinstanceClass.ValueNotSupported', 'message' => 'The specified parameter DBinstanceClass is invalid.', 'http_code' => 400, 'description' => 'The specified parameter DBinstanceClass is invalid.'],
['code' => 'InvalidDBInstanceClassNotFound', 'message' => 'Specified DB instance class is not found.', 'http_code' => 400, 'description' => 'The specified instance does not exist or does not support'],
['code' => 'InvalidDBInstanceConnAddress.Ipv6', 'message' => 'Specified DB instance public ConnectionAddress include ipv6.', 'http_code' => 400, 'description' => 'The public endpoint uses an IPv6 address.'],
['code' => 'InvalidDBInstanceConnType.Classic', 'message' => 'Specified DB instance ConnectionAddress include classic net.', 'http_code' => 400, 'description' => 'The instance uses the classic network.'],
['code' => 'InvalidDBInstanceConnType.Format', 'message' => 'The specified instance connection type is not valid.', 'http_code' => 400, 'description' => 'This operation is not supported for the connection type of the current instance.'],
['code' => 'InvalidDBInstanceConnType.Format', 'message' => 'Specified DB instance conn type is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the connection type of the RDS instance.'],
['code' => 'InvalidDBInstanceDescription.Format', 'message' => 'Specified DB instance description is not valid.', 'http_code' => 400, 'description' => 'The DBInstanceDescription parameter is invalid. Check the parameter value. The parameter must meet the following rules: the length must be 2 to 256 characters. It must start with a Chinese character or letter and can contain digits, Chinese characters, letters, underscores (_), and hyphens (-).'],
['code' => 'InvalidDBInstanceDescription.Malformed', 'message' => 'The specified parameter DBInstanceDescription is not valid.', 'http_code' => 400, 'description' => 'The format of the description for the instance is incorrect.'],
['code' => 'InvalidDBInstanceDescription.Malformed', 'message' => 'The specified parameter "DBInstanceDescription" is not valid.', 'http_code' => 400, 'description' => 'The instance description failed the verification check. The description must be 2 to 256 characters in length and can contain letters, underscores (_), and hyphens (-). The description must start with a letter and cannot start with http:// or https://.'],
['code' => 'InvalidDBInstanceEngineType.Format', 'message' => 'the DB instance engine type does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the database engine of the instance.'],
['code' => 'InvalidDBInstanceId.MalFormed', 'message' => 'The specified parameter DBInstanceId is not valid.', 'http_code' => 400, 'description' => 'The instance ID is invalid. Check the instance ID.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created and whether the RDS instance has not been deleted.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'Invalid DBInstanceId NotFound.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The provided InstanceId does not exist.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check that the RDS instance is created within the logged-on account and is not deleted.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'DBInstanceIdentifier does not refer to an existing DB instance.', 'http_code' => 404, 'description' => 'The ID of the RDS instance cannot be found among the IDs of the created RDS instances.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The specified instance is not found.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist.', 'http_code' => 404, 'description' => 'The RDS instance cannot be found. Check whether the RDS instance is created within the logged-on account.'],
['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in records.', 'http_code' => 400, 'description' => 'The DBInstanceId provided does not exist.'],
['code' => 'InvalidDBInstanceId.QuotaExceeded', 'message' => 'The quota of instance ID exceeded.', 'http_code' => 400, 'description' => 'The number of read-only RDS instances exceeds the upper limit.'],
['code' => 'InvalidDBInstanceIdOrDBInstanceName', 'message' => 'The specified params DBInstanceId or DBInstanceName should not be empty.', 'http_code' => 400, 'description' => 'The specified parameter DBInstanceId or DBInstanceName should not be empty.'],
['code' => 'InvalidDBInstanceIdUseType', 'message' => 'InvalidDBInstanceIdUseType.', 'http_code' => 404, 'description' => 'The instance ID is invalid.'],
['code' => 'InvalidDBInstanceName', 'message' => 'Specified parameter DBInstanceName is not valid.', 'http_code' => 400, 'description' => 'The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string.'],
['code' => 'InvalidDBInstanceName', 'message' => 'There is a problem with the specified parameter DBInstanceName, please check parameter DBInstanceName.', 'http_code' => 400, 'description' => 'There is a problem with the specified parameter DBInstanceName, please check parameter DBInstanceName.'],
['code' => 'InvalidDBInstanceName', 'message' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.', 'http_code' => 400, 'description' => 'The specified parameter DBInstanceName is null or the instance cannot be found, please check parameter DBInstanceName.'],
['code' => 'InvalidDBInstanceName.Deleted', 'message' => 'The specified DB instance is deleted.', 'http_code' => 404, 'description' => 'The RDS instance has been deleted.'],
['code' => 'InvalidDBInstanceName.Duplicate', 'message' => 'Specified instance name already exists in the Aliyun RDS.', 'http_code' => 400, 'description' => 'The operation failed. The instance name already exists. Modify the instance name.'],
['code' => 'InvalidDBInstanceName.Duplicate', 'message' => 'Specified DB instance name already exists in the Aliyun RDS.', 'http_code' => 400, 'description' => 'The operation failed. The instance name already exists. Specify a different name and try again.'],
['code' => 'InvalidDBInstanceName.Format', 'message' => 'Specified DB instance name is not valid.', 'http_code' => 400, 'description' => 'The instance does not exist. Check the instance information.'],
['code' => 'InvalidDBInstanceName.MultipleFound', 'message' => 'The specified DB instance name matches multiple instances.', 'http_code' => 400, 'description' => 'The specified instance name matches more than one instance, please re-enter'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The DBInstanceId provided does not exist.', 'http_code' => 404, 'description' => 'The instance ID cannot be found. Modify the instance ID and try again.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'Invalid DBInstanceId NotFound.', 'http_code' => 404, 'description' => 'The instance ID cannot be found.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The specified DB instance name does not exist.', 'http_code' => 400, 'description' => 'The instance name does not exist.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The instance ID cannot be found.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The specified db instance is not found.', 'http_code' => 404, 'description' => 'The operation failed. The instance ID cannot be found.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The database instance does not exist.', 'http_code' => 404, 'description' => 'The name of the RDS instance cannot be found. Check the name of the RDS instance.'],
['code' => 'InvalidDBInstanceName.NotFound', 'message' => 'The specified instance does not exist or is not supported.', 'http_code' => 404, 'description' => 'The specified instance does not exist or is not supported.'],
['code' => 'InvalidDBInstanceName.TooMuchItems', 'message' => 'The number of DB instance Names should be no more than 20.', 'http_code' => 400, 'description' => 'The number of instance names passed in at a time cannot be greater than 20.'],
['code' => 'InvalidDBInstanceNetType.NotFound', 'message' => 'Specified DB instance net type is not found.', 'http_code' => 404, 'description' => 'The operation failed. The network type of the RDS instance is invalid. Specify a valid network type.'],
['code' => 'InvalidDBInstanceNetType.NotFound', 'message' => 'The specified instance network type is not found.', 'http_code' => 400, 'description' => 'The network type of the RDS instance is invalid. Specify a valid network type. Valid values: VPC and Classic.'],
['code' => 'InvalidDBInstanceNetType.NotSupported', 'message' => 'The specified parameter "InvalidDBInstanceNetType" is not valid.', 'http_code' => 400, 'description' => 'The network connection type is invalid.'],
['code' => 'InvalidDBinstanceNetType.ValueNotSupport', 'message' => 'The specified parameter DBinstanceNetType is not valid.', 'http_code' => 400, 'description' => 'The network connection type of the RDS instance is invalid.'],
['code' => 'InvalidDBinstanceNetType.ValueNotSupport', 'message' => 'The specified parameter "DBinstanceNetType" is not valid.', 'http_code' => 400, 'description' => 'The network type of the RDS instance is invalid. Valid values:'."\n"
.'VPC: VPC network type'."\n"
.'Classic: classic network type'],
['code' => 'InvalidDBInstanceNetType.ValueNotSupported', 'message' => 'The specified parameter "InvalidDBInstanceNetType" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The network type is invalid. Check the network type. Standard SSDs and ESSDs support only the VPC network type.'],
['code' => 'InvalidDBInstanceStatus.NotSupport', 'message' => 'The Specified instance status is not supported to query database list.', 'http_code' => 400, 'description' => 'You cannot query databases when the instance is in the current state.'],
['code' => 'InvalidDBInstanceStorage', 'message' => 'The specified DBInstanceStorage is invalid.', 'http_code' => 400, 'description' => 'The specified DBInstanceStorage parameter is invalid.'],
['code' => 'InvalidDBInstanceStorage.Format', 'message' => 'InvalidDBInstanceStorage.Format', 'http_code' => 400, 'description' => 'The storage capacity is invalid. Check the storage capacity.'],
['code' => 'InvalidDBInstanceStorage.NotSupported', 'message' => 'The specified parameter "DBInstanceStorage" is not valid.', 'http_code' => 400, 'description' => 'The DBInstanceStorage parameter is invalid. Check the parameter.'],
['code' => 'InvalidDBInstanceStorage.ValueNotSupported', 'message' => 'The specified parameter "DBInstanceStorage" is not valid.', 'http_code' => 400, 'description' => 'The instance storage setting is invalid. Reset the storage. The supported storage ranges for each engine are as follows: MySQL supports 5 to 1000 GB. SQL Server supports 10 to 1000 GB. PostgreSQL and PPAS support 5 to 2000 GB.'],
['code' => 'InvalidDBInstanceStorageType', 'message' => 'The specified DBInstanceStorageType is invalid.', 'http_code' => 400, 'description' => 'The specified DBInstanceStorageType parameter is invalid.'],
['code' => 'InvalidDBInstanceType.Format', 'message' => 'Specified instance type is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The database engine is invalid. Specify a valid database engine.'],
['code' => 'InvalidDBInstanceType.ValueNotSupport', 'message' => 'The specified parameter"DBInstanceType" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The instance type is invalid. Specify a valid instance type.'],
['code' => 'InvalidDBInstanceType.VNotSupport', 'message' => 'The specified parameter DBInstanceType is not valid.', 'http_code' => 400, 'description' => 'The value of the DBInstanceType parameter is invalid. Specify a valid value.'],
['code' => 'InvalidDBName', 'message' => 'The specified database name is not allowed.', 'http_code' => 400, 'description' => 'The database name is invalid. Check the database name.'],
['code' => 'InvalidDBName.Duplicate', 'message' => 'Specified DB name already exists in the This instance.', 'http_code' => 400, 'description' => 'A database with the same name has been created on the RDS instance. Specify a different name.'],
['code' => 'InvalidDBName.Duplicate', 'message' => 'The Security db Name is not in the available range or occupied.', 'http_code' => 400, 'description' => 'The database name is invalid. Specify a valid name.'],
['code' => 'InvalidDBName.Forbid', 'message' => 'Specified DB name is a keyword in RDS.', 'http_code' => 400, 'description' => 'Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.'],
['code' => 'InvalidDBName.Format', 'message' => 'Specified DB name is not valid.', 'http_code' => 400, 'description' => 'The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['code' => 'InvalidDBName.Malformed', 'message' => 'The specified parameter "DBName" is not valid.', 'http_code' => 400, 'description' => 'The database name is invalid. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.'],
['code' => 'InvalidDBName.Malformed', 'message' => 'The specified parameter \'DBName\' is not valid.', 'http_code' => 400, 'description' => 'The value of the DBName parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidDBName.Malformed', 'message' => 'The database name can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter and end with a letter or digit.', 'http_code' => 400, 'description' => 'The database name can be up to 64 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter and end with a letter or a digit.'],
['code' => 'InvalidDBName.NotFound', 'message' => 'The specified database is not found.', 'http_code' => 400, 'description' => 'The database cannot be found. Check the name of the database.'],
['code' => 'InvalidDBName.NotFound', 'message' => 'Specified DB name does not exist.', 'http_code' => 400, 'description' => 'The database name cannot be found. Enter a valid database name.'],
['code' => 'InvalidDBName.NotFound', 'message' => 'Specified one or more DB name does not exist or DB status does not support.', 'http_code' => 404, 'description' => 'The operation failed. The instance name cannot be found.'],
['code' => 'InvalidDBNameOrAccountPrivilege', 'message' => 'Account permissions and database names must correspond.', 'http_code' => 400, 'description' => 'The account can have only one permission on the database.'],
['code' => 'InvalidDBOrAccontName.Duplicate', 'message' => 'Specified DB or account name already exists in share host instance.', 'http_code' => 400, 'description' => 'The database name or the username is duplicate. Check and modify the database name or the username.'],
['code' => 'InvalidDbProxyConnectionString.NotFound', 'message' => 'The specified database proxy connection string is not found.', 'http_code' => 404, 'description' => 'The operation failed. The database proxy endpoint cannot be found.'],
['code' => 'InvalidDBProxyConnectStringNetType.NotSupported', 'message' => 'The Specified DBProxyConnectStringNetType is not supported.', 'http_code' => 400, 'description' => 'The specified DBProxyConnectStringNetType value is not supported.'],
['code' => 'InvalidDBProxyNodes.AzProximity', 'message' => 'current proxy is open az proximity and target proxy not support az proximity.', 'http_code' => 400, 'description' => 'current proxy is open az proximity and target proxy not support az proximity.'],
['code' => 'InvalidDBProxyNodes.General', 'message' => 'general-purpose proxy does not support more than 2 nodes.', 'http_code' => 400, 'description' => 'Generic proxy does not support more than 2 nodes.'],
['code' => 'InvalidDBProxyNodes.Node', 'message' => 'must set DBProxyNodes params with more than 2 proxy nodes.', 'http_code' => 400, 'description' => 'must set DBProxyNodes params with more than 2 proxy nodes.'],
['code' => 'InvalidDBProxyNodes.ZoneId', 'message' => 'The number of zone is request 1 or 2.', 'http_code' => 400, 'description' => 'The ZoneId of the DBProxyNodes field can only be one or two zones.'],
['code' => 'InvalidDBProxyNodes.ZoneIdAndNodeCounts', 'message' => 'The number of node count and zone count is mismatch.', 'http_code' => 400, 'description' => 'The number of zones or nodes is invalid.'],
['code' => 'InvalidDBProxyNodes.ZoneIdNotUnique', 'message' => 'ZoneIds is not unique.', 'http_code' => 400, 'description' => 'The Availability Zone ID is not unique.'],
['code' => 'InvalidDbProxyStatus', 'message' => 'The proxy status of the database is abnormal.', 'http_code' => 400, 'description' => 'The operation failed. The database proxy of the RDS instance is abnormal.'],
['code' => 'InvalidDBState', 'message' => 'The DB state does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The database is not in a ready state.'],
['code' => 'InvalidDBType', 'message' => 'The DB type does not support this operation.', 'http_code' => 400, 'description' => 'The DB type does not support this operation.'],
['code' => 'InvalidDedicatedHostGroupId', 'message' => 'The specified DedicatedHostGroupId is invalid.', 'http_code' => 400, 'description' => 'The specified DedicatedHostGroupId parameter is invalid.'],
['code' => 'InvalidDedicatedHostId.NotFound', 'message' => 'The specified DedicatedHostId does not exist in our records.', 'http_code' => 403, 'description' => 'The specified dedicated host ID does not exist in our records.'],
['code' => 'InvalidDefaultVSwitch.NotFound', 'message' => 'InvalidDefaultVSwitch.NotFound', 'http_code' => 400, 'description' => 'The operation failed. The vSwitch cannot be found in the VPC.'],
['code' => 'InvalidDeploymentSetName.Malformed', 'message' => 'Specified deployment set name is not valid.', 'http_code' => 400, 'description' => 'The specified DeploymentSetName parameter is invalid.'],
['code' => 'InvalidDescription.CustomMalformed', 'message' => 'Customized section of host description is invalid, please use valid format.', 'http_code' => 400, 'description' => 'The custom instance description is illegal.'],
['code' => 'InvalidDescription.Format', 'message' => 'Specified description is not valid.', 'http_code' => 400, 'description' => 'The description is invalid.'],
['code' => 'InvalidDescription.Malformed', 'message' => 'The specified parameter "Description" is not valid.', 'http_code' => 400, 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['code' => 'InvalidDescription.Malformed', 'message' => 'The specified description is wrongly formed.', 'http_code' => 404, 'description' => 'The specified resource description format is invalid. The length is 2 to 256 characters and cannot start with http:// and https.'],
['code' => 'InvalidDevice.Malformed', 'message' => 'The specified device is not valid.', 'http_code' => 400, 'description' => 'The specified cloud disk device name does not exist.'],
['code' => 'InvalidDisk.CategoryFormat', 'message' => 'The specified eed category does not support this operation.', 'http_code' => 400, 'description' => 'Elastic temporary disk does not support this operation'],
['code' => 'InvalidDisk.SystemDiskFormat', 'message' => 'The specified system disk does not support this operation.', 'http_code' => 400, 'description' => 'The billing method of a system cloud disk cannot be changed independently.'],
['code' => 'InvalidDiskCategory.NotSupported', 'message' => 'The specified disk category is not support the specified instance type.', 'http_code' => 403, 'description' => 'The specified cloud disk type is not supported by this instance type.'],
['code' => 'InvalidDiskCategory.ValueNotSupported', 'message' => 'Specified disk category is not supported.', 'http_code' => 400, 'description' => 'The specified cloud disk type is not supported.'],
['code' => 'InvalidDiskId.NotFound', 'message' => 'The specified disk does not exist.', 'http_code' => 404, 'description' => 'The specified disk does not exist. Please check whether the disk ID is correct.'],
['code' => 'InvalidDiskName.Malformed', 'message' => 'The specified disk name is wrongly formed.', 'http_code' => 400, 'description' => 'The disk name format is incorrect. It can be 2 to 128 characters in length and start with an English letter or a Chinese letter. It can contain digits, periods (.), underscores (_), or hyphens (-). Cannot start with http:// and https.'],
['code' => 'InvalidDiskSize.NotSupported', 'message' => 'The specified parameter size is not valid.', 'http_code' => 400, 'description' => 'The specified disk capacity is invalid.'],
['code' => 'InvalidDiskType', 'message' => 'Current disk type does not support this operation.', 'http_code' => 400, 'description' => 'The current disk type does not support this operation'],
['code' => 'InvalidEActionCode.CodeBizNotSupported', 'message' => 'The specified action code biz is not valid.', 'http_code' => 400, 'description' => 'The operation code biz is invalid.'],
['code' => 'InvalidEcsId.NotFound', 'message' => 'The specified instance ID does not exist.', 'http_code' => 404, 'description' => 'The specified instance ID does not exist.'],
['code' => 'InvalidEcsSecurityGroupId', 'message' => 'Specified ecs security group id is not valid.', 'http_code' => 400, 'description' => 'The specified ECS security group ID is invalid.'],
['code' => 'InvalidEEDDisk.DeleteWithInstanceConflict', 'message' => 'The specified disk is not a portable disk and cannot be set to DeleteWithInstance attribute false.', 'http_code' => 400, 'description' => 'Elastic temporary disk needs to be released with instance release'],
['code' => 'InvalidEEDDisk.NotSupport', 'message' => 'The specified eed category does not support this operation.', 'http_code' => 400, 'description' => 'Flexible temporary disk does not support this operation'],
['code' => 'InvalidEffectiveTime.SpecialTimeIsNull', 'message' => 'SpecialTime is not valid.', 'http_code' => 400, 'description' => 'The value of SpecialTime is invalid.'],
['code' => 'InvalidEncryptionKeyValue', 'message' => 'The specified encryption key is not allowed for general-purpose instance. Please check your parameters.', 'http_code' => 400, 'description' => 'Universal instances do not support cloud disk encryption.'],
['code' => 'InvalidEndPoint.Format', 'message' => 'The specified EndPoint is not valid.', 'http_code' => 400, 'description' => 'The dedicated proxy connection address ID (DBProxyEndpointId) is not specified or does not exist. Check the Endpoint parameter.'],
['code' => 'InvalidEndpointType.Format', 'message' => 'The specified EndpointType is invalid.', 'http_code' => 400, 'description' => 'The value of the EndpointType parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => 'The end time is invalid. Check the end time.'],
['code' => 'InvalidEndTime.Format', 'message' => 'The specified parameter "EndTime" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The end time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter "EndTime" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The format of the end time is invalid. The format must be in standard GMT format: YYYY-MM-DDThh:mmZ. Example: 2012-06-11T15:00Z.'],
['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter "EndTime" is not valid.', 'http_code' => 403, 'description' => 'The operation failed. The end time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is before this service active time.', 'http_code' => 400, 'description' => 'The format of end time is invalid. GMT is the valid format: YYYY-MM-DDThh:mmZ. Example: 2012-06-11T15:00Z.'],
['code' => 'InvalidEngine.Malformed', 'message' => 'The specified parameter Engine is not valid.', 'http_code' => 400, 'description' => 'The value of the Engine parameter is invalid. Specify a valid value.'],
['code' => 'InvalidEngine.Malformed', 'message' => 'Specified engine is not valid.', 'http_code' => 400, 'description' => 'The database engine is invalid. Specify a valid database engine.'],
['code' => 'InvalidEngine.Malformed', 'message' => 'The specified parameter "Engine" is not valid.', 'http_code' => 400, 'description' => 'The database engine failed the verification check. The database engine must be MySQL, SQL Server, PostgreSQL, or PPAS.'],
['code' => 'InvalidEngine.NotFound', 'message' => 'Specified engine does not exist or engine version does not support this operation.', 'http_code' => 404, 'description' => 'The database engine version is not supported.'],
['code' => 'InvalidEngine.NotSupport', 'message' => 'The specified parameter "Engine" is not valid.', 'http_code' => 400, 'description' => 'The database engine is not supported.'],
['code' => 'InvalidEngine.NotSupported', 'message' => 'The specified parameter "Engine" is not valid.', 'http_code' => 400, 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
['code' => 'InvalidEngine.NotSupported', 'message' => 'Current engine does not support this api.', 'http_code' => 400, 'description' => 'The operation is not supported for the database engine that is run on the RDS instance.'],
['code' => 'InvalidEngine.NotSupported', 'message' => 'The current instance does not support describe license info.', 'http_code' => 400, 'description' => 'The current instance does not support this description permission information.'],
['code' => 'InvalidEngine.ValueNotSupport', 'message' => 'The specified parameter "Engine" is not valid.', 'http_code' => 400, 'description' => 'The database type is invalid. Select a valid database type.'],
['code' => 'InvalidEngine.VauleNotSupported', 'message' => 'The specified parameter "Engine" is not valid.', 'http_code' => 400, 'description' => 'The database engine is invalid. The database engine must be MySQL, SQL Server, PostgreSQL, or PPAS.'],
['code' => 'InvalidEngineOrEngineVersion', 'message' => 'The specified params engine or engineVersion should not be null.', 'http_code' => 400, 'description' => 'The engine or engineVersion parameter cannot be null.'],
['code' => 'InvalidEngineVersion', 'message' => 'The specified EngineVersion is invalid.', 'http_code' => 400, 'description' => 'The specified EngineVersion parameter is invalid.'],
['code' => 'InvalidEngineVersion.Malformed', 'message' => 'The specified parameter "EngineVersion" is not valid.', 'http_code' => 400, 'description' => 'The database engine version is not supported.'],
['code' => 'InvalidEngineVersion.Malformed', 'message' => 'Specified engine version is not valid.', 'http_code' => 400, 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['code' => 'InvalidEngineVersion.Malformed', 'message' => 'The specified parameter EngineVersion is not valid.', 'http_code' => 400, 'description' => 'The database engine version is invalid. Check the database engine version and try again.'],
['code' => 'InvalidEngineVersion.NotSupport', 'message' => 'The specified parameter "EngineVersion" is not valid.', 'http_code' => 400, 'description' => 'The database engine version is not supported. If you select MySQL, MySQL 5.5, MySQL 5.6, and MySQL 5.7 are supported. If you select SQLServer, SQL Server 2008 R2 and SQL Server 2012 are supported. If you select PostgreSQL, only PostgreSQL 9.4 is supported. If you select PPAS, only PPAS 9.3 is supported.'],
['code' => 'InvalidEngineVersion.NotSupported', 'message' => 'The specified parameter "EngineVersion" is not valid.', 'http_code' => 400, 'description' => 'The value of the EngineVersion parameter is invalid. Specify a valid value.'],
['code' => 'InvalidEngineVersion.NotSupported', 'message' => 'Current db instance does not support sysadmin.', 'http_code' => 400, 'description' => 'The operation failed. The current instance does not support creating sysAdmin accounts.'],
['code' => 'InvalidEngineVersion.ValueNotSupport', 'message' => 'The specified parameter "EngineVersion" is not valid.', 'http_code' => 400, 'description' => 'The database engine version is invalid. Specify a valid database engine version.'],
['code' => 'InvalidEngineVersion.ValueNotSupported', 'message' => 'The specified parameter "EngineVersion" is not valid.', 'http_code' => 400, 'description' => 'The version of database engines version failed the verification check. Valid values:'."\n"
.'MySQL: 5.5, 5.6, and 5.7.'."\n"
.'SQL Server: 2008r2 and 2012.'."\n"
.'PostgreSQL: 9.4.'."\n"
.'PPAS: 9.3.'],
['code' => 'InvalidEngineVersionInRegion.NotAvailable', 'message' => 'The EngineVersion in the Region is not available.', 'http_code' => 403, 'description' => 'The database engine version is not supported in the region.'],
['code' => 'InvalidEni.NotSameVpc', 'message' => 'The specified resource and the specified ENI do not belong to the same VPC. For more information, see the actual return result of the error message placeholder %s.', 'http_code' => 403, 'description' => 'The specified resource and the specified ENI do not belong to the same VPC. For more information, see the actual return result of the error message placeholder %s.'],
['code' => 'InvalidEniId.NotFound', 'message' => 'The specified Elastic Network Interface ID does not exist.', 'http_code' => 404, 'description' => 'The specified Elastic Network Interface ID does not exist.'],
['code' => 'InvalidEniQueueSize.RegionOrUserNotSupported', 'message' => 'The specified RxQueueSize or TxQueueSize parameter is not supported in this region, or this account is not on the whitelist for using eni QueueSize.', 'http_code' => 400, 'description' => 'Region or user does not support setting NIC queue depth'],
['code' => 'InvalidEssdStorageSize', 'message' => 'The cloud ESSD storage size is invalid.', 'http_code' => 400, 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['code' => 'InvalidEssdStorageSize', 'message' => 'invalid cloud essd storage size.', 'http_code' => 400, 'description' => 'The storage size of cloud disks is invalid. Check the storage size.'],
['code' => 'InvalidEssdStorageSize', 'message' => 'The general essd size must be greater than 10GB, The ESSD PL0 must be greater than 10G, PL1 must be greater than 20G, PL2 must be greater than 465G, PL3 must be greater than 1265G.', 'http_code' => 400, 'description' => 'The size of the high-performance cloud disk must be no less than 10GB,essd PL0 must be no less than 10G,PL1 must be no less than 20G,PL2 must be no less than 465G, and PL3 must be no less than 1265G.'],
['code' => 'InvalideStatus', 'message' => 'Parent migrate task status is invalid.', 'http_code' => 400, 'description' => 'The parent migration task is abnormal.'],
['code' => 'InvalideStatus.Format', 'message' => 'The instance status does not support this operation.', 'http_code' => 400, 'description' => 'The instance status does not support this operation.'],
['code' => 'InvalidEVENT', 'message' => 'Current DB instance has event schedule, this operation is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported because the current instance has an event.'],
['code' => 'InvalidExpectExpireTime.Format', 'message' => 'The specified param ExpectExpireTime is not valid.', 'http_code' => 400, 'description' => 'The specified param ExpectExpireTime is not valid.'],
['code' => 'InvalidExpired.Format', 'message' => 'The instance expiration status parameter is incorrect.', 'http_code' => 400, 'description' => 'The parameter that specifies the instance expiration status is invalid.'],
['code' => 'InvalidExpiredTime.Format', 'message' => 'Specified expired time is not valid.', 'http_code' => 400, 'description' => 'The value of the ExpiredTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'],
['code' => 'InvalidExpiredTime.Malformed', 'message' => 'The specified ExpiredTime is not valid.', 'http_code' => 400, 'description' => 'The expiration time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2016-06-09T19:18:00Z.'],
['code' => 'InvalidExpirePeriod.Malformed', 'message' => 'The specified parameter "ExpirePeriod" is not valid.', 'http_code' => 400, 'description' => 'The validity period is invalid. Valid value s: 1 to 180. Unit: days.'],
['code' => 'InvalidFile', 'message' => 'The operation does not support this kind of file', 'http_code' => 400, 'description' => 'The operation failed. The format of the file is not supported.'],
['code' => 'InvalidFileName.Format', 'message' => 'Specified file name is not valid.', 'http_code' => 400, 'description' => 'The value of the FileName parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidFileName.Malformed', 'message' => 'The specified parameter "FileName" is not valid.', 'http_code' => 400, 'description' => 'The FileName parameter is invalid. Check whether the parameter value is correct.'],
['code' => 'InvalidFileName.Malformed', 'message' => 'The specified parameter FileName is not valid.', 'http_code' => 400, 'description' => 'The FileName parameter is invalid. Check whether the parameter value is correct.'],
['code' => 'InvalidFileName.NotAvailable', 'message' => 'The specified FileName is not Available.', 'http_code' => 400, 'description' => 'The value of the FileName parameter is invalid. Specify a valid value.'],
['code' => 'InvalidFileName.NotAvailable', 'message' => 'The specified "FileName" is not Available .', 'http_code' => 404, 'description' => 'The file name cannot be found. Check the file name.'],
['code' => 'InvalidFileName.NotCompleted', 'message' => 'The specified FileName is not completed .', 'http_code' => 400, 'description' => 'The file name is invalid.'],
['code' => 'InvalidFileName.NotCompleted', 'message' => 'The specified FileName is not completed.', 'http_code' => 400, 'description' => 'The specified FileName parameter is incomplete. Specify the parameter again.'],
['code' => 'InvalidFileName.NotFound', 'message' => 'The FileName provided does not exist.', 'http_code' => 403, 'description' => 'The file cannot be found. Check the file information.'],
['code' => 'InvalidFileName.NotFound', 'message' => 'The specified file name does not exist.', 'http_code' => 404, 'description' => 'The file name cannot be found.'],
['code' => 'InvalidForceSwitch.Format', 'message' => 'Specified force switch is not valid.', 'http_code' => 400, 'description' => 'The value of the ForceSwitch parameter is invalid.'],
['code' => 'InvalidGeneralGroupName.Malformed', 'message' => 'The specified parameter GeneralGroupName is not valid.', 'http_code' => 400, 'description' => 'The value of the GeneralGroupName parameter is invalid.'],
['code' => 'InvalidGeneralGroupNameOrGdnInstanceName', 'message' => 'The specified params generalGroupName or gdnInstanceName should not be null.', 'http_code' => 400, 'description' => 'The generalGroupName or gdInsttanceName parameter cannot be empty.'],
['code' => 'InvalidGroupName.DuplicatedWithTemplate', 'message' => 'Sepecified group name is used by whitelist template.', 'http_code' => 400, 'description' => 'The whitelist group name conflicts with the whitelist template associated with the instance.'],
['code' => 'InvalidGroupName.Malformed', 'message' => 'The specified parameter "DBInstanceIPArrayName" is not valid.', 'http_code' => 400, 'description' => 'The name of the IP address whitelist is invalid.'],
['code' => 'InvalidGroupName.Malformed', 'message' => 'Specified DBInstanceIPArrayName param does not support this operation.', 'http_code' => 400, 'description' => 'The specified DBInstanceIPArrayName parameter does not support this operation'],
['code' => 'InvalidGroupPolicyValue', 'message' => 'The value of the group policy is invalid.', 'http_code' => 400, 'description' => 'Illegal parameter GroupPolicy'],
['code' => 'InvalidGuardInstanceId.Exist', 'message' => 'The guard instance has exist.', 'http_code' => 404, 'description' => 'The disaster recovery instance already exists.'],
['code' => 'InvalidGuardInstanceId.Exist', 'message' => 'The guard instance existed.', 'http_code' => 404, 'description' => 'The disaster recovery instance already exists.'],
['code' => 'InvalidHamode.Malformed', 'message' => 'The specified parameter HAMode is not valid.', 'http_code' => 403, 'description' => 'The parameter hamode is invalid. Check the parameter again.'],
['code' => 'InvalidHostName.CustomMalformed', 'message' => 'Customized section of host name is invalid, please use valid format: [], [,], [m,], [,n], [m,n].', 'http_code' => 400, 'description' => 'The custom part of the hostname is invalid, please use a valid format:[], [,], [m,], [, n], [m, n].'],
['code' => 'InvalidHostStatus.Format', 'message' => 'Specified host status is not valid.', 'http_code' => 400, 'description' => 'The current status of the host does not support this operation.'],
['code' => 'InvalidImageId.NotFound', 'message' => 'The specified ImageId does not exist.', 'http_code' => 400, 'description' => 'The specified ImageId does not exist.'],
['code' => 'InvalidImportDataType.Malformed', 'message' => 'The specified parameter \'ImportDataType\' is not valid.', 'http_code' => 400, 'description' => 'The value of the ImportDataType parameter is invalid. Set this parameter to Full or Incremental.'],
['code' => 'InvalidImportId.ImportIdvalue', 'message' => 'The operation is not permitted due to ImportId value.', 'http_code' => 403, 'description' => 'The ID of the import task is invalid.'],
['code' => 'InvalidImportId.NotFound', 'message' => 'The ImportId provided does not exist in our records.', 'http_code' => 403, 'description' => 'The value of the ImportId parameter cannot be found.'],
['code' => 'InvalidIncreaseValue.NotEnouth', 'message' => 'The resource is insufficient.', 'http_code' => 400, 'description' => 'The operation failed. The available resources are insufficient. Please try again later.'],
['code' => 'InvalidInquiryPriceFault', 'message' => 'The request not refer to the correct order price. please contact customer service.', 'http_code' => 403, 'description' => 'An inquiry error occurred. Contact Alibaba Cloud customer service representatives.'],
['code' => 'InvalidInquiryPriceParamFault', 'message' => 'The request not refer to the correct order price param. please contact customer service.', 'http_code' => 403, 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['code' => 'InvalidInsName', 'message' => 'The InsName is invalid', 'http_code' => 400, 'description' => 'The specified InsName parameter is invalid.'],
['code' => 'InvalidInstance.ModifyChargeTypeCountLimited', 'message' => 'The modify the number of instanceIds is limited.', 'http_code' => 400, 'description' => 'The number of modified instances exceeds the limit'],
['code' => 'InvalidInstance.NetworkType', 'message' => 'The network type of the specified instance is invalid.', 'http_code' => 403, 'description' => 'The network type of the specified instance is invalid.'],
['code' => 'InvalidInstance.NotFound', 'message' => 'The specified instance does not exist.', 'http_code' => 404, 'description' => 'The specified instance does not exist.'],
['code' => 'InvalidInstance.NotMatch', 'message' => 'The specified instance type does not match the command.', 'http_code' => 400, 'description' => 'The specified instance ID does not support executing the specified command ID. Please check if the instance status meets the execution conditions for the cloud assistant command.'],
['code' => 'InvalidInstance.UnPaidOrder', 'message' => 'The specified Instance has unpaid orders.', 'http_code' => 403, 'description' => 'You have an unpaid order for the instance. Pay for the order and try again.'],
['code' => 'InvalidInstanceID.Malformed', 'message' => 'The format of the InstanceId parameter is incorrect.', 'http_code' => 400, 'description' => 'Parameter InstanceId format error.'],
['code' => 'InvalidInstanceId.NotFound', 'message' => 'InstanceId is invalid, not found.', 'http_code' => 400, 'description' => 'Invalid InstanceId, no valid instance data found'],
['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified instance does not exist. Check whether the parameter InstanceId is correct.', 'http_code' => 403, 'description' => 'The specified instance does not exist. Check whether the parameter InstanceId is correct.'],
['code' => 'InvalidInstanceId.NotFound', 'message' => 'Specified attached instance does not exist.', 'http_code' => 404, 'description' => 'The specified instance does not exist. Check whether the instance ID is correct.'],
['code' => 'InvalidInstanceId.OSTypeUnsupported', 'message' => 'The OS type of the instance %s corresponding to the parameter InstanceId does not support the operation.', 'http_code' => 403, 'description' => 'The OS type of the instance corresponding to the parameter InstanceId does not support the operation.'],
['code' => 'InvalidInstanceIp.Duplicate', 'message' => 'Invalid security ip list specified', 'http_code' => 404, 'description' => 'The IP address whitelist is invalid.'],
['code' => 'InvalidInstanceIp.Duplicate', 'message' => 'Invalid security ip list specified, duplicated.', 'http_code' => 404, 'description' => 'The IP address whitelist is invalid.'],
['code' => 'InvalidInstanceKind.NotSupport', 'message' => 'The instance kind does not support this operation.', 'http_code' => 400, 'description' => 'The instance type does not support this operation.'],
['code' => 'InvalidInstanceLevel.DiskType', 'message' => 'Specified instance level not support request disk type', 'http_code' => 400, 'description' => 'The current instance type does not support the specified storage type.'],
['code' => 'InvalidInstanceLevel.Malformed', 'message' => 'The specified class code does not support the endpoint number. Please check the shard number and the current endpoint number.', 'http_code' => 403, 'description' => 'The operation failed. The number of proxy terminals that you configure is not supported for the instance type. Check the number of data shards and the number of proxy terminals.'],
['code' => 'InvalidInstanceLevel.Malformed', 'message' => 'Current DB instance level does not support this operation.', 'http_code' => 403, 'description' => 'The specified database instance type does not support this operation.'],
['code' => 'InvalidInstanceLevelExtraInfo', 'message' => 'Specified class code has error extra info.', 'http_code' => 400, 'description' => 'The specified class code contains invalid additional information.'],
['code' => 'InvalidInstanceLockMode', 'message' => 'The DB instance lock mode does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the lock mode of the RDS instance.'],
['code' => 'InvalidInstanceMetricsConfigs.NotFound', 'message' => 'The specified instance has no metrics configs', 'http_code' => 400, 'description' => 'The specified instance does not have performance metric configurations.'],
['code' => 'InvalidInstanceName.CustomMalformed', 'message' => 'The instance name is invalid, please use valid format.', 'http_code' => 400, 'description' => 'Instance name format does not conform to specification'],
['code' => 'InvalidInstanceNetworkType', 'message' => 'The specified InstanceNetworkType is invalid.', 'http_code' => 400, 'description' => 'The specified InstanceNetworkType is invalid.'],
['code' => 'InvalidInstanceNetworkType.ValueNotSupported', 'message' => 'The specified parameter "InstanceNetworkType" is not valid.', 'http_code' => 400, 'description' => 'The network type failed the verification check. The supported network types are VPC and classic network.'],
['code' => 'InvalidInstanceParameter', 'message' => 'Specified name for the instance parameter is not valid.', 'http_code' => 400, 'description' => 'The name specified for the instance parameter is invalid.'],
['code' => 'InvalidInstancesRegion.Malformed', 'message' => 'The instance region is not the same as the target instance region.', 'http_code' => 403, 'description' => 'The destination instance resides in a different region from the source instance.'],
['code' => 'InvalidInstanceState', 'message' => 'The DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is unavailable.'],
['code' => 'InvalidInstanceStateFault', 'message' => 'The DB instance is not in a valid state.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is unavailable.'],
['code' => 'InvalidInstanceStatus.NotStopped', 'message' => 'The specified Instance status is not stopped.', 'http_code' => 400, 'description' => 'The specified Instance status is not stopped.'],
['code' => 'InvalidInstanceStorageType.NotFound', 'message' => 'The specified DBInstanceStorageType is not found.', 'http_code' => 404, 'description' => 'You must specify the InstanceStorageType parameter.'],
['code' => 'InvalidInstanceType', 'message' => 'The DB instance type does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the instance type of the RDS instance.'],
['code' => 'InvalidInstanceType.NotSupportDiskCategory', 'message' => 'The instanceType of the specified instance does not support this disk category.', 'http_code' => 400, 'description' => 'The instanceType of the specified instance does not support this disk category.'],
['code' => 'InvalidInstanceType.NotSupported', 'message' => 'The specified InstanceType is not Supported.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'InvalidInstanceType.NotSupported', 'message' => 'The specified instance type is not supported.', 'http_code' => 400, 'description' => 'The specified instance type is not supported.'],
['code' => 'InvalidInstanceType.ValueNotSupported', 'message' => 'The specified InstanceType does not exist or beyond the permitted range.', 'http_code' => 400, 'description' => 'The specified InstanceType does not exist or beyond the permitted range.'],
['code' => 'InvalidInstanceType.ZoneNotSupported', 'message' => 'The specified zone does not support this instancetype.', 'http_code' => 400, 'description' => 'The specified zone does not support this instancetype.'],
['code' => 'InvalidInstanceUseType.NotSupport', 'message' => 'Specified instanceUseType does not support in RDS.', 'http_code' => 400, 'description' => 'The operation failed. The role that is specified by the instanceUseType parameter is not supported for the RDS instance.'],
['code' => 'InvalidInstanceVersion', 'message' => 'Source instance version is greater than the target instance version.', 'http_code' => 403, 'description' => 'The version of the source instance is later than the version of the target instance.'],
['code' => 'InvalidInsType.Malformed', 'message' => 'Specified instance type is not valid.', 'http_code' => 404, 'description' => 'The instance type is invalid.'],
['code' => 'InvalidIORequestTimes.Format', 'message' => 'Specified instance IO request times is not valid.', 'http_code' => 400, 'description' => 'The specified IORequestTimes parameter is invalid.'],
['code' => 'InvalidIp.Address', 'message' => 'The input IP format is incorrect or not within the selectable CIDR range.', 'http_code' => 403, 'description' => 'The input IP format is incorrect or not within the selectable CIDR range.'],
['code' => 'InvalidIP.Format', 'message' => 'The specified IP address is illegal or invalid.', 'http_code' => 400, 'description' => 'The specified IP address is illegal or invalid'],
['code' => 'InvalidIp.IpPrefixIllegal', 'message' => 'The ip prefixes %s is/are illegal.', 'http_code' => 403, 'description' => 'Invalid IP prefix, not cidr format.'],
['code' => 'InvalidIp.IpPrefixMaskIllegal', 'message' => 'The current IP prefix mask is illegal.', 'http_code' => 403, 'description' => 'The current IP prefix mask is illegal.'],
['code' => 'InvalidIp.IpPrefixMaskInvalid', 'message' => 'The IP prefix mask %s is illegal which must be between %s and %s.', 'http_code' => 403, 'description' => 'The IP prefix mask is illegal, not within the valid range.'],
['code' => 'InvalidIp.IpPrefixMaskNotSame', 'message' => 'The IP prefixes %s are illegal. The IP prefix mask must be the same.', 'http_code' => 403, 'description' => 'The IP prefix masks are not the same.'],
['code' => 'InvalidIp.IpPrefixMustInReserveSegment', 'message' => 'The ip prefix must in vswitch reserve segment.', 'http_code' => 403, 'description' => 'The IP prefix is invalid and is not in the reserved address segment of the switch.'],
['code' => 'InvalidIp.IpPrefixNotAvailable', 'message' => 'The IP prefix is not available.', 'http_code' => 403, 'description' => 'The IP prefix is not available.'],
['code' => 'InvalidIp.IpPrefixNotStrict', 'message' => 'The IP prefix \'%s\' must be in strict CIDR format.', 'http_code' => 403, 'description' => 'The IP prefix is invalid, not in strict CIDR format.'],
['code' => 'InvalidIp.IpRepeated', 'message' => 'The specified IP is repeated.', 'http_code' => 403, 'description' => 'The specified IP is repeated.'],
['code' => 'InvalidIPAddress.Conflict', 'message' => 'IP address conflict.', 'http_code' => 400, 'description' => 'An IP address conflict occurred.'],
['code' => 'InvalidIPArrayAttribute.Format', 'message' => 'The format of the IP attribute is invalid.', 'http_code' => 400, 'description' => 'The specified DBInstanceIPArrayAttribute parameter is invalid. Specify a valid value and try again. If the value that you specify contains multiple entries, separate the entries with commas (,). Each entry must be unique. Valid entries are in one of the following formats:'."\n"
.'IP address, such as 10.23.12.24.'."\n"
.'CIDR, such as 10.23.12.0/24. In this example, 24 indicates that the prefix in each IP address is 24 bits in length. You can replace 24 with an integer within the range of 1 to 32.'],
['code' => 'InvalidIPList.Format', 'message' => 'Specified IPList is not valid.', 'http_code' => 400, 'description' => 'The IP list configured in the whitelist template is invalid.'],
['code' => 'InvalidIPList.Malformed', 'message' => 'The specified ipList is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'The IP address whitelist is invalid. Check whether the IP address whitelist contains an empty string.'],
['code' => 'InvalidIPList.Malformed', 'message' => 'The specified ipList is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The value of the ipList parameter is invalid. Check the value of this parameter is an empty string.'],
['code' => 'InvalidIsLockTable.Malformed', 'message' => 'The specified parameter IsLockTable is not valid.', 'http_code' => 403, 'description' => 'The value of the IsLockTable parameter is invalid. Specify a valid value.'],
['code' => 'InvalidIsLockTable.Malformed', 'message' => 'The specified parameter "IsLockTable" is not valid.', 'http_code' => 403, 'description' => 'The value of the IsLockTable parameter is invalid. Specify a valid value.'],
['code' => 'InvalidIzNo.NotSupported', 'message' => 'the Specified vpc Zone not supported.', 'http_code' => 400, 'description' => 'The zone does not support VPC-hosted RDS instances. Specify a different zone.'],
['code' => 'InvalidIzNo.NotSupported', 'message' => 'Specified VPC zone is not supported.', 'http_code' => 400, 'description' => 'The VPC cannot be found in the zone. Specify a different VPC and try again.'],
['code' => 'InvalidKey.Malformed', 'message' => 'Specified key is not valid.', 'http_code' => 400, 'description' => 'The value of the Tag.N.Key parameter is invalid. This parameter is used to add a tag to an RDS instance. The letter N in the parameter name represents an integer within the range of 1 to 20. You can specify this parameter multiple times to add multiple tags to an RDS instance. For example, if you want to add two tags to an RDS instance, you can specify two parameters: Tag.1.Key and Tag.2.Key.'],
['code' => 'InvalidKmsKey', 'message' => 'Kms key is disabled.', 'http_code' => 403, 'description' => 'The KMS key is disabled.'],
['code' => 'InvalidLauncher.LengthLimitExceeded', 'message' => 'The length of the parameter Launcher exceeds the limit of 1 KB characters.', 'http_code' => 403, 'description' => 'The length of the argument Launcher exceeds the limit of 1 KB characters.'],
['code' => 'InvalidLockReason.Format', 'message' => 'Specified instance lock reason is not valid.', 'http_code' => 400, 'description' => 'The specified instance is in a locked state and cannot be accessed.'],
['code' => 'InvalidLogBackupFrequency.Malformed', 'message' => 'Invalid log backup frequency.', 'http_code' => 400, 'description' => 'The value of the LogBackupFrequency parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidLogBackupLocalRetentionSpace.Malformed', 'message' => 'The specified LogBackupLocalRetentionSpace is not valid.', 'http_code' => 404, 'description' => 'The value of the LogBackupFrequency parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidLogBackupRetentionPeriod.Malformed', 'message' => 'The Specified LogBackupRetentionPeriod is not valid.', 'http_code' => 400, 'description' => 'The specified LogBackupRetentionPeriod parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidLogRetention.NotSupport', 'message' => 'The specified log retention is not valid', 'http_code' => 404, 'description' => 'The log retention period is invalid. Specify a valid log retention period in the range of 1 to 1,000 days.'],
['code' => 'InvalidLogRetention.NotSupport', 'message' => 'The specified log retention is not valid,The current instance type does not support this operation.', 'http_code' => 404, 'description' => 'The log retention period is invalid. Valid values: 1 to 1000. Unit: days.'],
['code' => 'InvalidMaintainTime', 'message' => 'The MaintainTime parameter is invalid.', 'http_code' => 400, 'description' => 'The MaintainTime parameter in your request is missing or invalid.'],
['code' => 'InvalidMaintainTime.MalFormed', 'message' => 'The specified parameter MaintainTime is not valid.', 'http_code' => 400, 'description' => 'The operation failed. Call the operation during the specified maintenance window. You can mofidy the maintenance window. Set the maintenance window of an ApsaraDB RDS for MySQL instance.'],
['code' => 'InvalidMasterHostName', 'message' => 'The specified zoneId of the master host is different from the zoneId of the master.', 'http_code' => 400, 'description' => 'The zone ID of the host is different from the ID of the primary zone.'],
['code' => 'InvalidMasterHostName', 'message' => 'The specified master host zoneId is different from the master zoneId.', 'http_code' => 400, 'description' => 'The zone ID of the host is different from the ID of the primary zone.'],
['code' => 'InvalidMaxDelayTime.Malformed', 'message' => 'The specified MaxDelayTime format is not valid.', 'http_code' => 404, 'description' => 'The latency threshold is invalid. Unit: seconds. Specify a valid latency threshold.'],
['code' => 'InvalidMaxRecordsPerPage.Malformed', 'message' => 'Specified record number is not valid.', 'http_code' => 403, 'description' => 'The specified record number is invalid.'],
['code' => 'InvalidMaxscaleConnectionString.NotFound', 'message' => 'The specified database proxy connection string is not found.', 'http_code' => 404, 'description' => 'The operation failed. The database proxy endpoint cannot be found.'],
['code' => 'InvalidMaxscaleConnectString.NotFound', 'message' => 'Specified MaxscaleConnectionString is not found or not belong to this endpoint.', 'http_code' => 404, 'description' => 'Specified MaxscaleConnectionString is not found or not belong to this endpoint.'],
['code' => 'InvalidMaxscaleMinorVersion.Format', 'message' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'http_code' => 403, 'description' => 'The in-use MaxScale of the instance is outdated. Upgrade MaxScale first.'],
['code' => 'InvalidMeta.Empty', 'message' => 'Meta information is empty.', 'http_code' => 403, 'description' => 'The meta information is empty. Check whether a full backup has not been performed after the database table is restored.'],
['code' => 'InvalidMeta.TooLarge', 'message' => 'Meta information is too large.', 'http_code' => 403, 'description' => 'The metadata information is too large. Check whether the number of instance tables exceeds 50000.'],
['code' => 'InvalidMetricsConfig', 'message' => 'The specified metrics config is invalid.', 'http_code' => 400, 'description' => 'The specified metric configuration is invalid.'],
['code' => 'InvalidMigrateAZInfo', 'message' => 'Invalid MigrateAZ params.', 'http_code' => 400, 'description' => 'The MigrateAZ parameter is invalid.'],
['code' => 'InvalidMigrateModifyClassOrStorage', 'message' => 'Specified parameter DBInstanceClass or Storage is invalid.', 'http_code' => 400, 'description' => 'The specified DBInstanceClass or Storage parameter is invalid.'],
['code' => 'InvalidMigrateStatus', 'message' => 'The migrate target instance is not synced with source instance.', 'http_code' => 400, 'description' => 'The destination migration instance is not synchronized with the source instance.'],
['code' => 'InvalidMigrateTask', 'message' => 'The specified MigrateTaskId 237360 does not exist. Please check again.', 'http_code' => 400, 'description' => 'The backup data migration task with the 237360 ID cannot be found.'],
['code' => 'InvalidMigrateTask', 'message' => 'No running migrate task found.', 'http_code' => 400, 'description' => 'No running migration task found.'],
['code' => 'InvalidMigrationID.NotFound', 'message' => 'The specified migration record does not exist.', 'http_code' => 404, 'description' => 'The migration task record cannot be found.'],
['code' => 'InvalidMigrationType.Format', 'message' => 'Specified migration type is not valid.', 'http_code' => 400, 'description' => 'The specified migration type is invalid.'],
['code' => 'InvalidMinorVerison.NotFound', 'message' => 'The specified minor version is not found.', 'http_code' => 400, 'description' => 'The operation failed. The minor engine version cannot be found.'],
['code' => 'InvalidMinorVerison.NotFound', 'message' => 'InvalidMinorVerison.NotFound', 'http_code' => 400, 'description' => 'The operation failed. The minor engine version cannot be found.'],
['code' => 'InvalidMinorVerison.NotFound', 'message' => 'Specify minor version not founud.', 'http_code' => 400, 'description' => 'The operation failed. The minor engine version cannot be found.'],
['code' => 'InvalidMinorVersion.NotFound', 'message' => 'The specified minor version does not exist.', 'http_code' => 400, 'description' => 'The operation failed. The database engine version cannot be found.'],
['code' => 'InvalidMinorVersion.NotFound', 'message' => 'Specified minor version does not exists.', 'http_code' => 400, 'description' => 'The operation failed. The database engine version cannot be found.'],
['code' => 'InvalidMinorVersionAlreadyLatest', 'message' => 'The minor version of the instance is already the latest version.', 'http_code' => 400, 'description' => 'The RDS instance runs the latest minor engine version.'],
['code' => 'InvalidMinorVersionAlreadyLatest', 'message' => 'Minor version for instance is already the latest version.', 'http_code' => 400, 'description' => 'The RDS instance runs the latest minor engine version.'],
['code' => 'InvalidMinorVersionLowerThanInstance', 'message' => 'The specified minor version must not be lower than the current version of the instance.', 'http_code' => 400, 'description' => 'Check the new database engine version. The new database engine version cannot be earlier than the database engine version that is run on the RDS instance.'],
['code' => 'InvalidMinorVersionLowerThanInstance', 'message' => 'Specify minor version cannot not be lower than current instance.', 'http_code' => 400, 'description' => 'The new database engine version cannot be earlier than the database engine version that is run on the RDS instance. Check the new database engine version.'],
['code' => 'InvalidMultiparamZoneInfoList', 'message' => 'Zoneinfo list is invaild.', 'http_code' => 403, 'description' => 'The current primary zone is not aligned. The primary instance cannot be migrated.'],
['code' => 'InvalidMultiTenant', 'message' => 'Multi tenants cannot exist in a same instance.', 'http_code' => 400, 'description' => 'An instance does not allow nodes of multiple tenant types.'],
['code' => 'InvalidMySQLEngineVersionSupportVector', 'message' => 'Invalid MySQL Engine Version Support Vector.', 'http_code' => 403, 'description' => 'This MySQL version does not support the vector feature.'],
['code' => 'InvalidNetType.Format', 'message' => 'Specified NetType is not valid.', 'http_code' => 400, 'description' => 'The value of the NetType parameter is invalid.'],
['code' => 'InvalidNetworkTypeClassicWhenCloudStorage', 'message' => 'The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.', 'http_code' => 400, 'description' => 'When selecting a cloud storage type, specifying a InstanceNetworkType value of Classic is not valid.'],
['code' => 'InvalidNodeId', 'message' => 'Parameter node id is not valid.', 'http_code' => 400, 'description' => 'The nodeId parameter is invalid.'],
['code' => 'InvalidNodeId.NotFound', 'message' => 'The target node does not exist in the current instance.', 'http_code' => 404, 'description' => 'The target node does not exist in the current instance.'],
['code' => 'InvalidNodeItems.BlackNodeItems', 'message' => 'NodeItems is blank.', 'http_code' => 400, 'description' => 'The node data cannot be empty.'],
['code' => 'InvalidNodeItems.DBInstanceId', 'message' => 'Specified dbInstanceId is invalid', 'http_code' => 400, 'description' => 'The specified dbInstanceId parameter in NodeItems is invalid.'],
['code' => 'InvalidNodeItems.DuplicateNodeId', 'message' => 'Duplicate nodeId, please ensure all nodeIds are different.', 'http_code' => 400, 'description' => 'Duplicate NodeId parameter values exist in NodeItems.'],
['code' => 'InvalidNodeItems.JsonFormat', 'message' => 'NodeItems is not a json string.', 'http_code' => 400, 'description' => 'The NodeItems parameter value must be a JSON string.'],
['code' => 'InvalidNodeItems.NodeId', 'message' => 'Specified Node id is invalid', 'http_code' => 400, 'description' => 'A NodeId parameter value in NodeItems is not found among instances.'],
['code' => 'InvalidNodeItems.ReplicaSet', 'message' => 'Specified dbInstanceId is invalid', 'http_code' => 400, 'description' => 'The specified dbInstanceId parameter in NodeItems is invalid.'],
['code' => 'InvalidNodeItems.RONode', 'message' => 'ReadOnly endpoint can not contain readonly instance node.', 'http_code' => 400, 'description' => 'The read-only endpoint cannot contain the read-only instance.'],
['code' => 'InvalidNodeItems.RONodeId', 'message' => 'ReadOnly endpoint can not contain readonly ins node.', 'http_code' => 400, 'description' => 'The read-only endpoint cannot contain the read-only instance in NodeItems.'],
['code' => 'InvalidNodeItems.RONodeIdMaster', 'message' => 'ReadOnly endpoint can not contain master node.', 'http_code' => 400, 'description' => 'The read-only endpoint cannot contain the primary instance in NodeItems.'],
['code' => 'InvalidNodeItems.RONodeIdPrimary', 'message' => 'ReadOnly endpoint can not contain primary node.', 'http_code' => 400, 'description' => 'The read-only endpoint cannot contain the primary instance.'],
['code' => 'InvalidNodeType.NotSupport', 'message' => 'The specified nodeType does not support.', 'http_code' => 400, 'description' => 'The specified node type is not supported.'],
['code' => 'InvalidOldInstanceType.NotSupport', 'message' => 'Specified oldInstanceType does not support in RDS.', 'http_code' => 400, 'description' => 'This operation is not supported for the database engine version of the current instance.'],
['code' => 'InvalidOperation.Add', 'message' => 'Current instance is already in Domain, if you want join another domain, please remove first.', 'http_code' => 403, 'description' => 'the current instance has been joined to an ad domain. if you want to join another ad domain, remove the added ad domain.'],
['code' => 'InvalidOperation.AddressAlreadyAllocated', 'message' => 'The specified IP has already been allocated.', 'http_code' => 404, 'description' => 'The specified IP has already been allocated.'],
['code' => 'InvalidOperation.AddressNotInVSwitchCidr', 'message' => 'The specified ipv6 does not match VSwitch cidr scope.', 'http_code' => 404, 'description' => 'The specified IPv6 does not match the VSwitch CIDR scope.'],
['code' => 'InvalidOperation.AvailabilityZoneMismatch', 'message' => 'The operation is invalid.', 'http_code' => 403, 'description' => 'The operation is invalid.'],
['code' => 'InvalidOperation.BoundingEniSlaveQuotaExceed', 'message' => 'The number of Slave ENIs exceeds the limit of Bond ENI.', 'http_code' => 403, 'description' => 'The number of Slave ENIs exceeds the limit of Bond ENI.'],
['code' => 'InvalidOperation.ConnectionTrackingConfigNotSupportMemberEni', 'message' => 'Member eni does not support ConnectionTrackingConfiguration.', 'http_code' => 400, 'description' => 'Member eni does not support ConnectionTrackingConfiguration.'],
['code' => 'InvalidOperation.DataDiskNotSupport', 'message' => 'Specified instance does not support the data disk category or size.', 'http_code' => 403, 'description' => 'The instance to be mounted does not support the disk category or size.'],
['code' => 'InvalidOperation.DataDiskNotSupport', 'message' => 'The specified instance dose not support the data disk category or size.', 'http_code' => 403, 'description' => 'The instance type does not support the disk type or size.'],
['code' => 'InvalidOperation.DeletionProtection', 'message' => '%s.', 'http_code' => 400, 'description' => 'This operation is invalid. Cancel the release protection of the instance first.'],
['code' => 'InvalidOperation.DetachPrimaryEniNotAllowed', 'message' => 'Detaching the primary network interface is not allowed.', 'http_code' => 400, 'description' => 'Detaching the primary NIC of an instance is not allowed.'],
['code' => 'InvalidOperation.DisableStorageCompression', 'message' => 'The specified operation disable storage compression is not supported.', 'http_code' => 400, 'description' => 'The specified operation disable storage compression is not supported.'],
['code' => 'InvalidOperation.EipBindModel', 'message' => 'The EIP binding model is invalid.', 'http_code' => 403, 'description' => 'The EIP binding model is invalid.'],
['code' => 'InvalidOperation.EnableIpv6Failed', 'message' => 'The specified VSwitch does not support Ipv6 feature.', 'http_code' => 404, 'description' => 'The specified VSwitch does not support IPv6 feature.'],
['code' => 'InvalidOperation.EniCountExceeded', 'message' => 'The maximum number of eni in a enterprise level security group is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of NICs in the Enterprise Security Group has been reached.'],
['code' => 'InvalidOperation.EniHotPlugNotSupported', 'message' => 'The ENI with high-performance traffic mode cannot be hot-plugged. Please stop the ECS instance to which the ENI is attached, and try again.', 'http_code' => 400, 'description' => 'An ENI with high-performance communication mode enabled does not support hot unplugging. Stop the ECS instance to which the ENI is mounted and try again.'],
['code' => 'InvalidOperation.EniLinked', 'message' => 'The current ENI of the instance is associated with another ENI, causing the operation to be invalid. You need to disassociate before you can detach from an instance.', 'http_code' => 403, 'description' => 'The current ENI of the instance is associated with another ENI, causing the operation to be invalid. You need to disassociate before you can detach from an instance.'],
['code' => 'InvalidOperation.EniQueuePairNumberOverflow', 'message' => 'The number of ENI queue pairs overflows.', 'http_code' => 403, 'description' => 'The number of ENI queue pairs overflows.'],
['code' => 'InvalidOperation.EniServiceManaged', 'message' => 'The operation is invalid.', 'http_code' => 403, 'description' => 'The operation is invalid.'],
['code' => 'InvalidOperation.EniTrafficModeNotSupportIpv6', 'message' => 'The High Performance(RDMA) traffic mode does not support IPv6.', 'http_code' => 404, 'description' => 'The High Performance (RDMA) traffic mode does not support IPv6.'],
['code' => 'InvalidOperation.EniTrunkDeviceFull', 'message' => 'The ENI trunk device is full.', 'http_code' => 403, 'description' => 'The ENI trunk device is full.'],
['code' => 'InvalidOperation.EniTypeNotSupportAttachToTrunk', 'message' => 'The ENI type does not support attachment to a trunk.', 'http_code' => 403, 'description' => 'The ENI type does not support attachment to a trunk.'],
['code' => 'InvalidOperation.EniTypeNotSupportTrunking', 'message' => 'The type of the specified ENI does not support trunking. For more information, see the actual return result of the error message placeholder %s.', 'http_code' => 403, 'description' => 'The type of the specified ENI does not support trunking. For more information, see the actual return result of the error message placeholder %s.'],
['code' => 'InvalidOperation.ExceedInstanceTypeQueueNumber', 'message' => 'The total number of elastic network interface queues exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.', 'http_code' => 403, 'description' => 'The total number of elastic network interface queues exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.'],
['code' => 'InvalidOperation.HasMemberEniAttached', 'message' => 'The ENI of the specified relay mode is appended with other ENIs. For details, see the actual return result of the error message% s placeholder.', 'http_code' => 403, 'description' => 'The ENI of the specified relay mode is appended with other ENIs. For details, see the actual return result of the error message% s placeholder.'],
['code' => 'InvalidOperation.HasSlaveEniBonded', 'message' => 'The network interface still has bonded SLAVE network interfaces.', 'http_code' => 400, 'description' => 'The network interface still has bonded SLAVE network interfaces.'],
['code' => 'InvalidOperation.HighPerformanceEniPerInstanceLimitExceeded', 'message' => 'The limit for high performance ENIs per instance has been exceeded.', 'http_code' => 403, 'description' => 'The limit for high performance ENIs per instance has been exceeded.'],
['code' => 'InvalidOperation.HighPerformanceTrafficModeEniUnsupported', 'message' => 'High performance traffic mode does not support the current ENI type. Expected ENI type is "%s" but the current ENI type is "%s".', 'http_code' => 403, 'description' => 'The RDMA communication mode does not support the current ENI type.'],
['code' => 'InvalidOperation.HighPerformanceTrafficModeIsNotAllowed', 'message' => 'High performance traffic mode does not support the current ENI type. Expected ENI type is "%s" but the current ENI type is "%s".', 'http_code' => 403, 'description' => 'The RDMA communication mode does not support the current ENI type.'],
['code' => 'InvalidOperation.HighPerformanceTrafficModeNotSupportMemberEni', 'message' => 'High performance traffic mode does not support member ENIs.', 'http_code' => 403, 'description' => 'High performance traffic mode does not support member ENIs.'],
['code' => 'InvalidOperation.HighPerformanceTrafficModeNotSupportTrunkEni', 'message' => 'High performance traffic mode does not support trunk ENIs.', 'http_code' => 403, 'description' => 'High performance traffic mode does not support trunk ENIs.'],
['code' => 'InvalidOperation.HotPlugNotSupport', 'message' => 'The specified resource is in running state and does not support this operation. For more information, see the actual return result of the error message placeholder %s.', 'http_code' => 403, 'description' => 'The specified resource is in running state and does not support this operation. For more information, see the actual return result of the error message placeholder %s.'],
['code' => 'InvalidOperation.InstanceTypeNotSupport', 'message' => 'The instance type of the specified instance does not support hot detach disk.', 'http_code' => 403, 'description' => 'The instance to which the disk is attached does not support disk hot swapping.'],
['code' => 'InvalidOperation.InstanceTypeNotSupportEniTrunking', 'message' => 'The specified instance type does not support ENI trunking. For more information, see the actual return result of the error message placeholder %s.', 'http_code' => 403, 'description' => 'The specified instance type does not support ENI trunking. For more information, see the actual return result of the error message placeholder %s.'],
['code' => 'InvalidOperation.InstanceTypeNotSupportHighPerformance', 'message' => 'The ECS instance type where the ENI is located does not support the RDMA mode.', 'http_code' => 400, 'description' => 'The ECS instance type where the ENI is located does not support the RDMA communication mode.'],
['code' => 'InvalidOperation.InstanceTypeNotSupportRDMA', 'message' => 'The specified instance type does not support high performance traffic mode NICs.', 'http_code' => 403, 'description' => 'The specified instance type does not support high performance traffic mode NICs.'],
['code' => 'InvalidOperation.InstanceTypeNotSupportRss', 'message' => 'The ECS instance type does not support Rss.', 'http_code' => 400, 'description' => 'The ECS instance type does not support Rss.'],
['code' => 'InvalidOperation.Invalid', 'message' => 'Current instance is not in Domain, remove operation is only valid when current instance is in domain.', 'http_code' => 403, 'description' => 'The current instance is not in a domain. The delete operation is valid only when the instance is in a domain.'],
['code' => 'InvalidOperation.InvalidEcsState', 'message' => 'The current state of the instance does not support this operation.', 'http_code' => 400, 'description' => 'The current state of the instance does not support this operation.'],
['code' => 'InvalidOperation.InvalidEniPageNumber', 'message' => 'Invalid Page Number.', 'http_code' => 403, 'description' => 'Invalid PageNumber'],
['code' => 'InvalidOperation.InvalidEniState', 'message' => 'The current state of the elastic network interface does not support this operation.', 'http_code' => 400, 'description' => 'The current state of the elastic network interface does not support this operation.'],
['code' => 'InvalidOperation.InvalidEniType', 'message' => 'The current ENI type does not support this operation.', 'http_code' => 403, 'description' => 'The current ENI type does not support this operation.'],
['code' => 'InvalidOperation.InvalidGeneration', 'message' => 'This operation is invalid.', 'http_code' => 400, 'description' => 'This operation is invalid.'],
['code' => 'InvalidOperation.InvalidRegion', 'message' => 'The specified RegionId parameter is invalid.', 'http_code' => 400, 'description' => 'The specified RegionId parameter is invalid.'],
['code' => 'InvalidOperation.InvalidTrunkEniStatus', 'message' => 'The status of the specified trunk mode ENI does not allow this operation. For more information, see the actual return result of the error message placeholder %s.', 'http_code' => 403, 'description' => 'The status of the specified trunk mode ENI does not allow this operation. For more information, see the actual return result of the error message placeholder %s.'],
['code' => 'InvalidOperation.Ipv4CountExceeded', 'message' => 'IPv4 count has reached the limit, making this operation invalid.', 'http_code' => 403, 'description' => 'IPv4 count has reached the limit, making this operation invalid.'],
['code' => 'InvalidOperation.Ipv6CountExceeded', 'message' => 'The operation is invalid as the IPv6 count has reached its limit.', 'http_code' => 403, 'description' => 'The operation is invalid as the IPv6 count has reached its limit.'],
['code' => 'InvalidOperation.Ipv6NotSupport', 'message' => 'IPv6 does not support the current operation.', 'http_code' => 403, 'description' => 'IPv6 does not support the current operation.'],
['code' => 'InvalidOperation.MaxEniIpv6IpsCountExceeded', 'message' => 'Maximum number of IPv6 addresses for ENI exceeded.', 'http_code' => 404, 'description' => 'The number of IPv6 addresses of the ENI exceeds the maximum limit.'],
['code' => 'InvalidOperation.MaxEniQueueNumberExceeded', 'message' => 'The elastic network interface queue number exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.', 'http_code' => 403, 'description' => 'The elastic network interface queue number exceeds the upper limit. For more information, see the actual return result of the %s placeholder in the error message.'],
['code' => 'InvalidOperation.MaxEniQueuePairNumberExceed', 'message' => 'The number of ENI queue pairs exceeds the maximum allowed.', 'http_code' => 403, 'description' => 'The number of ENI queue pairs exceeds the maximum allowed.'],
['code' => 'InvalidOperation.ModifyPrimaryEniQueueNumber', 'message' => 'Primary NetworkInterface is not allowed to modify queue number.', 'http_code' => 403, 'description' => 'The master NetworkInterface is not allowed to modify the queue number.'],
['code' => 'InvalidOperation.MultiGroupType', 'message' => 'The specified instance can\'t join different types of security group.', 'http_code' => 403, 'description' => 'The specified instance cannot be added to a security group of a different type.'],
['code' => 'InvalidOperation.NodeStatusNotSupported', 'message' => 'Please delete the pods on the vNode before deleting the vNode.', 'http_code' => 400, 'description' => 'Delete the pods on the vNode before deleting the vNode.'],
['code' => 'InvalidOperation.NotSupport', 'message' => 'The specified region does not support allocating IPv6 when creating ENI.', 'http_code' => 403, 'description' => 'The specified region does not support allocating IPv6 when creating ENI.'],
['code' => 'InvalidOperation.NotSupportEnterpriseGroup', 'message' => 'The specified instance type doesn\'t support enterprise level security group.', 'http_code' => 403, 'description' => 'The specified instance type doesn\'t support enterprise level security group.'],
['code' => 'InvalidOperation.NotSupportModifyQueueNumber', 'message' => 'The operation to modify the queue number is not supported.', 'http_code' => 400, 'description' => 'The operation of modifying the queue number is not supported.'],
['code' => 'InvalidOperation.NotSupportModifyVFQueueNumberAndVFQuantity', 'message' => 'The ENI not support modify VirtualFunctionTotalQueueNumber and VirtualFunctionQuantity when EnableSriov is true.', 'http_code' => 400, 'description' => 'Modifying VirtualFunctionTotalQueueNumber and VirtualFunctionQuantity is not supported when the EnableSriov is true'],
['code' => 'InvalidOperation.OtherInstanceUnsupported', 'message' => '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.', 'http_code' => 400, 'description' => '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.'],
['code' => 'InvalidOperation.PrimaryEniOnlySupportModifyNameAndDesc', 'message' => 'Primary NetworkInterface is only allowed to modify name and description.', 'http_code' => 404, 'description' => 'The primary NIC only supports modifying the NIC name and description.'],
['code' => 'InvalidOperation.RedeployRCInstance', 'message' => 'There are no maintenance events found on the instance.', 'http_code' => 400, 'description' => 'Maintenance event not found on instance'],
['code' => 'InvalidOperation.RegionNotSupportIpPrefix', 'message' => 'The current region does not support IP prefix feature.', 'http_code' => 500, 'description' => 'The current region does not support IP prefix feature.'],
['code' => 'InvalidOperation.Remove', 'message' => 'Current instance is not in Domain, remove operation is only valid when current instance is in domain.', 'http_code' => 403, 'description' => 'The current instance is not in the domain, and the delete operation is only valid if the current instance is in the domain.'],
['code' => 'InvalidOperation.ResourceManagedByCloudProduct', 'message' => 'The security group managed by the cloud product does not support modification operations.', 'http_code' => 403, 'description' => 'The security group managed by the cloud product does not support modification operations.'],
['code' => 'InvalidOperation.SecurityGroupNotAuthorized', 'message' => 'The specified security group is not authorized to operate.', 'http_code' => 401, 'description' => 'You do not have permission to operate the current security group.'],
['code' => 'InvalidOperation.SlaveEniMustHaveBondingEni', 'message' => 'Ensure you create the corresponding Bond ENI before creating Slave ENI.', 'http_code' => 404, 'description' => 'Ensure you create the corresponding Bond ENI before creating Slave ENI.'],
['code' => 'InvalidOperation.TrunkAttachmentMustEmpty', 'message' => 'The Attachment of the current Trunk type Network Interface must be empty when modify EnableSriov to true.', 'http_code' => 400, 'description' => 'When the modification EnableSriov is set to true, the device attached to the trunk NIC must be empty.'],
['code' => 'InvalidOperation.TrunkingIsNotAllowed', 'message' => 'Trunking network interface is not allowed to operate.', 'http_code' => 403, 'description' => 'Trunking network interface is not allowed to operate.'],
['code' => 'InvalidOperation.UserNotSupportNetworkCard', 'message' => 'User not support network card.', 'http_code' => 400, 'description' => 'User not support network card.'],
['code' => 'InvalidOperation.VpcMismatch', 'message' => 'The operation is invalid. Please confirm that the VPC in the operation matches other parameters.', 'http_code' => 403, 'description' => 'The operation is invalid. Please confirm that the VPC in the operation matches other parameters.'],
['code' => 'InvalidOperation.VSwitchCidrReservationNotExist', 'message' => 'The specified VSwitch does not have CIDR reservation.', 'http_code' => 404, 'description' => 'The specified VSwitch does not have CIDR reservation.'],
['code' => 'InvalidOperation.VSwitchIpv6Disabled', 'message' => 'The specified VSwitch does not support IPv6.', 'http_code' => 404, 'description' => 'The specified VSwitch does not support IPv6.'],
['code' => 'InvalidOperatorPermission.NotFound', 'message' => 'The permission provided does not exist.', 'http_code' => 404, 'description' => 'The OperatorPermission does not exist.'],
['code' => 'InvalidOptimizationCategory.Format', 'message' => 'Specified optimization category is not valid.', 'http_code' => 400, 'description' => 'The specified OptimizationCategory parameter is invalid.'],
['code' => 'InvalidOptimizations.Format', 'message' => 'Specified optimizations is not valid.', 'http_code' => 400, 'description' => 'The value of the Optimizations parameter is invalid. Specify a valid value.'],
['code' => 'InvalidOptmizationService', 'message' => 'Specified optimization service is not valid.', 'http_code' => 400, 'description' => 'The parameter optimization settings are invalid.'],
['code' => 'InvalidOrder.NotFound', 'message' => 'Specified order does not exist in RDS.', 'http_code' => 400, 'description' => 'The specified order does not exist in RDS.'],
['code' => 'InvalidOrderCharge.NotPay', 'message' => 'The specified parameter OrderCharge is not pay.', 'http_code' => 403, 'description' => 'You have unpaid orders for the RDS instance. Complete or cancel the orders and try again.'],
['code' => 'InvalidOrderCharge.NotSupport', 'message' => 'The specified order charge does not support in RDS.', 'http_code' => 404, 'description' => 'The operation failed. ApsaraDB RDS supports two billing methods: subscription (Prepaid) and pay-as-you-go (Postpaid). Specify a valid billing method by using the PayType parameter.'],
['code' => 'InvalidOrderCharge.NotSupport', 'message' => 'Specified order charge does not support in RDS.', 'http_code' => 404, 'description' => 'The operation failed. RDS supports Prepaid (subscription) and Postpaid (pay-as-you-go) billing methods. Please set the correct instance PayType (payment type).'],
['code' => 'InvalidOrderDateFault', 'message' => 'The request not refer to the correct order date. please check your Period or UsedTime param.', 'http_code' => 400, 'description' => 'No valid date is specified for the order in the request. Check the Period parameter or the UsedTime parameter in the order.'],
['code' => 'InvalidOrderId.NotFound', 'message' => 'Specified order does not exist in RDS.', 'http_code' => 400, 'description' => 'The specified order does not exist.'],
['code' => 'InvalidOrderPreiodFault', 'message' => 'The request not refer to the correct order preiod. please check your Period or UsedTime param.', 'http_code' => 400, 'description' => 'An inquiry error occurred for the subscription instance. Specify a renewal cycle.'],
['code' => 'InvalidOrderTask.NotSupport', 'message' => 'The order task existed.', 'http_code' => 400, 'description' => 'The operation failed. The current order task already exists.'],
['code' => 'InvalidOrderTask.NotSupport', 'message' => 'The Current InstanceId exist Order Task in RDS.', 'http_code' => 400, 'description' => 'Uncompleted order tasks are found in the RDS instance. Please try again later.'],
['code' => 'InvalidOrderTask.NotSupport', 'message' => 'The order task existed', 'http_code' => 400, 'description' => 'The operation failed. The task that is requested by the order has been created.'],
['code' => 'InvalidOssBackupFile.InvalidFile', 'message' => 'The specified OSS backup file is invalid.', 'http_code' => 400, 'description' => 'The operation failed. The backup file cannot be found in the OSS bucket.'],
['code' => 'InvalidOssObject.NotFound', 'message' => 'The Object not found in Oss.', 'http_code' => 404, 'description' => 'The object cannot be found in OSS buckets.'],
['code' => 'InvalidOssObjectPositions.Format', 'message' => 'The specified params OssObjectPositions is not valid.', 'http_code' => 403, 'description' => 'The OssObjectPositions parameter is invalid.'],
['code' => 'InvalidOssObjectStorageClassType', 'message' => 'The specified OSS bucket storage type is invalid.', 'http_code' => 400, 'description' => 'The storage class of the OSS bucket that stores the file is invalid.'],
['code' => 'InvalidOSSURL', 'message' => 'The Specified OSS URL is not valid', 'http_code' => 400, 'description' => 'The endpoint of the OSS bucket is incorrect.'],
['code' => 'InvalidOthers.Timeout', 'message' => 'Query timed out.Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => 'Request timed out, please try again or narrow the time range'],
['code' => 'InvalidPage.notFound', 'message' => 'Page not found.', 'http_code' => 404, 'description' => 'The specified parameters are not found. Check your parameters.'],
['code' => 'InvalidPageNumbers.Malformed', 'message' => 'Specified page number is not valid.', 'http_code' => 400, 'description' => 'The page number cannot be found.'],
['code' => 'InvalidPageParam.Format', 'message' => 'Page param should be a positive integer.', 'http_code' => 400, 'description' => 'The page number parameter must be a positive number.'],
['code' => 'InvalidPageSize', 'message' => 'Specified parameter pageSize is not valid.', 'http_code' => 400, 'description' => 'The value of the pageSize parameter is invalid. The value must be a number.'],
['code' => 'InvalidPageSize', 'message' => 'The page size is invalid', 'http_code' => 400, 'description' => 'The value of the pageSize parameter is invalid. The value of this parameter must be a number.'],
['code' => 'InvalidPageSize.Malformed', 'message' => 'The PageSize query string is malformed or does not adhere to standards.', 'http_code' => 400, 'description' => 'The value of the PageSize parameter is invalid.'],
['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => 'The value of the PageSize parameter is invalid.'],
['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => 'The value of the PageSize parameter failed the verification check. This parameter must be set to a numeric value. Check the value of this parameter.'],
['code' => 'InvalidParam', 'message' => 'The parameter is invalid.', 'http_code' => 404, 'description' => 'The operation failed. The values of some parameters are invalid.'],
['code' => 'InvalidParam', 'message' => 'The specified parameter is invalid.', 'http_code' => 404, 'description' => 'The input parameter is invalid.'],
['code' => 'InvalidParam', 'message' => 'The specified Weight is invalid.', 'http_code' => 404, 'description' => 'The weight is invalid.'],
['code' => 'InvalidParam', 'message' => 'Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'http_code' => 404, 'description' => 'The input parameter is invalid.'],
['code' => 'InvalidParam', 'message' => 'Invalid wal_level value.', 'http_code' => 404, 'description' => 'The input parameter is invalid.'],
['code' => 'InvalidParam', 'message' => 'Invalid params to call rds open api, BakDBNames is not empty.', 'http_code' => 404, 'description' => 'The BakDBNames parameter that is used to call the ApsaraDB RDS API is invalid. You must specify a value for the parameter.'],
['code' => 'InvalidParam', 'message' => 'Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.', 'http_code' => 400, 'description' => 'The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.'],
['code' => 'InvalidParam', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter error, please check the parameters.'],
['code' => 'InvalidParam', 'message' => 'Parameter error, please check the parameters.', 'http_code' => 400, 'description' => 'Parameter error, please check the parameters.'],
['code' => 'InvalidParam', 'message' => 'Specified parameter is not valid.', 'http_code' => 400, 'description' => 'Invalid input parameter'],
['code' => 'InvalidParam.acuType', 'message' => 'Parameter acuType is not valid.', 'http_code' => 400, 'description' => 'The parameter acuType is illegal, please check and re-enter.'],
['code' => 'InvalidParam.AcuType', 'message' => 'The parameter AcuType is invalid, please check and re-enter.', 'http_code' => 400, 'description' => 'The parameter acuType is illegal, please check and re-enter.'],
['code' => 'InvalidParam.Amount', 'message' => 'Amount is allowed from 1 to 20.', 'http_code' => 400, 'description' => 'Amount is allowed from 1 to 20.'],
['code' => 'InvalidParam.ClusterIdNotExist', 'message' => 'The specified cluster does not exist.', 'http_code' => 400, 'description' => 'The cluster passed in by the user does not exist.'],
['code' => 'InvalidParam.Cores', 'message' => 'The specified parameter \'Cores\' should be empty.', 'http_code' => 403, 'description' => 'The specified parameter \'Cores\' should be empty.'],
['code' => 'InvalidParam.CreateStrategy', 'message' => 'Only Atomicity and Partial are allowed.', 'http_code' => 400, 'description' => 'Only the Atomicity and Partial parameters are supported.'],
['code' => 'InvalidParam.DataDisKSizeInvalid', 'message' => 'The specified cloud disk size is invalid.', 'http_code' => 403, 'description' => 'The size of the disk does not match the type. Please insure the size of the cloud disk is within the supported range.'],
['code' => 'InvalidParam.DefaultVpcNotSupport', 'message' => 'Default vpc is not supported.', 'http_code' => 400, 'description' => 'The default VPC is not supported.'],
['code' => 'InvalidParam.DiskSize', 'message' => 'Request disksize %s is less than current used size %s x %s.', 'http_code' => 400, 'description' => 'The disk capacity selected during the change is too small!'],
['code' => 'InvalidParam.DiskSize', 'message' => '%s%s.', 'http_code' => 400, 'description' => 'The disk capacity selected during the change is too small!'],
['code' => 'InvalidParam.DiskSize', 'message' => '%s.', 'http_code' => 400, 'description' => 'The disk capacity selected during configuration change is small.'],
['code' => 'InvalidParam.Engine', 'message' => 'When amount is greater than one, only MySQL is allowed.', 'http_code' => 400, 'description' => 'When the amount is greater than one, only MySQL is allowed.'],
['code' => 'InvalidParam.Frequency', 'message' => 'The specified frequency is invalid.', 'http_code' => 400, 'description' => 'The specified frequency parameter is invalid. Please check if the parameter value is correct.'],
['code' => 'InvalidParam.InstanceNetworkType', 'message' => 'Creation of classic network instances is not supported.', 'http_code' => 400, 'description' => 'Classic network offline, does not support the creation of classic network instances!'],
['code' => 'InvalidParam.Memory', 'message' => 'The specified parameter \'Memory\' should be empty.', 'http_code' => 403, 'description' => 'The specified parameter \'Memory\' should be empty.'],
['code' => 'InvalidParam.NotExists', 'message' => 'The specified parameter does not exist.', 'http_code' => 400, 'description' => 'The parameter cannot be found.'],
['code' => 'InvalidParam.PageNumber', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified PageNumber parameter is invalid.'],
['code' => 'InvalidParam.PageSize', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified PageSize parameter is invalid.'],
['code' => 'InvalidParam.PayType', 'message' => 'When the PayType value is \'Prepaid\', the period or usedTime parameter value cannot be empty.', 'http_code' => 400, 'description' => 'When the PayType value is \'Prepaid\', the period or usedTime parameter value cannot be empty.'],
['code' => 'InvalidParam.Period', 'message' => 'When the parameter PayType value is \'Prepaid\', the parameter period value must be valid.', 'http_code' => 400, 'description' => 'When the parameter PayType value is \'Prepaid\', the parameter period value must be valid.'],
['code' => 'InvalidParam.POSTPAY', 'message' => 'It is not allowed to switch the payment method to postpaid after exceeding the purchase time limit for postpaid instances.', 'http_code' => 400, 'description' => 'When the classic network is offline, the current instance is of the classic network type and has exceeded the time limit of the post-payment instance. You cannot switch the payment method to post-payment.'],
['code' => 'InvalidParam.PREPAY', 'message' => 'The prepaid instance purchase limit has been exceeded, and changing the payment method to prepaid is not allowed.', 'http_code' => 400, 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the subscription limit. You are not allowed to switch to the subscription method.'],
['code' => 'InvalidParam.TargetStorage', 'message' => 'The target storage size cannot be less than 1.2 times the used size of the instance.', 'http_code' => 400, 'description' => 'The size of the target storage space cannot be less than 1.2 times the used space of the instance.'],
['code' => 'InvalidParam.TypeAndCpuMem.Conflict', 'message' => 'The specified \'InstanceType\' and \'Cores\',\'Memory\' are not blank at the same time.', 'http_code' => 403, 'description' => 'Cannot specify both \'InstanceType\' and \'Cores\', \'Memory\' at the same time.'],
['code' => 'InvalidParam.UsedTime', 'message' => 'When the parameter PayType value is \'Prepaid\', the parameter usedTime value must be valid.', 'http_code' => 400, 'description' => 'When the parameter PayType value is \'Prepaid\', the parameter usedTime value must be valid.'],
['code' => 'InvalidParam.UsedTime', 'message' => 'The renewal expiration date cannot exceed:%s.', 'http_code' => 400, 'description' => 'The current instance is of the classic network type, and the renewal time cannot exceed the limit time.'],
['code' => 'InvalidParam.UsedTime', 'message' => 'The clone expiration date cannot exceed %s.', 'http_code' => 400, 'description' => 'Because the classic network is offline, the usage time of the cloned classic network instance cannot exceed the limit time.'],
['code' => 'InvalidParamCombination', 'message' => 'VPCId,VSwitchId,PrivateIPAddress can not be modified with ConnectionStringPrefix,Port.', 'http_code' => 400, 'description' => 'A combination of the VPCId, VSwitchId, and PrivateIPAddress parameters and another combination of the ConnectionStringPrefix and Port parameters must meet the parameter combination requirements.'],
['code' => 'InvalidParamCombination', 'message' => 'Invalid parameter combination.', 'http_code' => 400, 'description' => 'The parameter combination is invalid.'],
['code' => 'InvalidParameter', 'message' => 'Invalid parameter.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter "RestoreTime" is not valid.', 'http_code' => 400, 'description' => ' '],
['code' => 'InvalidParameter', 'message' => 'The specified parameter "RetainInstance" is not valid.', 'http_code' => 400, 'description' => 'The value of the RetainInstance parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParameter', 'message' => 'Specified account name is not valid.', 'http_code' => 400, 'description' => 'The username of the account is invalid. The username can be up to 16 characters in length and must contain lowercase letters, digits, and underscores (_). The username must start with a lowercase letter and end with a lowercase letter or a digit.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter "RestoreType" is not valid.', 'http_code' => 400, 'description' => 'The value of the RestoreType parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter "dbInstanceId" is not valid.', 'http_code' => 400, 'description' => 'The value of the DBInstanceId parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParameter', 'message' => 'The specified RegionId does not exist.', 'http_code' => 400, 'description' => 'The region ID is invalid. Call the DescribeRegions operation to query the IDs of the available regions.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'InvalidParameter', 'message' => 'The provided parameter is invalid.', 'http_code' => 400, 'description' => 'The provided parameter is invalid.'],
['code' => 'InvalidParameter.AckEdgeParam', 'message' => 'The specified AckEdgeParam is not valid.', 'http_code' => 400, 'description' => 'AckEdgeParam parameter error.'],
['code' => 'InvalidParameter.AckMode', 'message' => 'CreteMode should be 1 and SupportCase should be edge.', 'http_code' => 400, 'description' => 'When creating an instance in Ack Edge mode, you need to set the CreteMode to 1 and the SupportCase to edge.'],
['code' => 'InvalidParameter.AckMode', 'message' => 'CreateMode should be 1 and SupportCase should be edge.', 'http_code' => 400, 'description' => 'When creating an instance in Ack Edge mode, you need to set the CreateMode to 1 and the SupportCase to edge.'],
['code' => 'InvalidParameter.AutoPay', 'message' => 'AutoPay should be true.', 'http_code' => 400, 'description' => 'The AutoPay should be true.'],
['code' => 'InvalidParameter.CompressionMode', 'message' => 'The specified parameter CompressionMode is not valid.', 'http_code' => 400, 'description' => 'The specified parameter CompressionMode is invalid.'],
['code' => 'InvalidParameter.Conflict', 'message' => 'The input parameters are invalid. Please check if there is a conflict between the parameters. The %s variable will dynamically return the error message based on the actual API call situation.', 'http_code' => 400, 'description' => 'The input parameters are invalid. Please check if there is a conflict between the parameters. The %s variable will dynamically return the error message based on the actual API call situation.'],
['code' => 'InvalidParameter.DataDiskNotSupported', 'message' => 'DataDisk is not supported for vNode.', 'http_code' => 400, 'description' => 'Container nodes temporarily do not support data disks.'],
['code' => 'InvalidParameter.Duration', 'message' => 'Specified Duration is not valid.', 'http_code' => 400, 'description' => 'The Duration parameter is invalid.'],
['code' => 'InvalidParameter.EniConnectionTrackingConfiguration', 'message' => 'The specified ENI connection tracking configuration "%s" must be between %s and %s.', 'http_code' => 400, 'description' => 'The network connection configuration specified by the network card exceeds the allowable range'],
['code' => 'InvalidParameter.EniEnhancedNetwork', 'message' => 'The input parameter "EnhancedNetwork" is illegal, when EnableSriov is true, VirtualFunctionTotalQueueNumber must not be empty, and VirtualFunctionQuantity must be 1 to 256. When EnableSriov is empty or false, VirtualFunctionTotalQueueNumber and VirtualFunctionQuantity must be empty.', 'http_code' => 400, 'description' => 'The specified network enhancement function parameter is illegal. When the EnableSriov is set to true, the VirtualFunctionTotalQueueNumber must not be empty and the VirtualFunctionQuantity value range is 1-256; When the EnableSriov is empty or set to false, the VirtualFunctionTotalQueueNumber and VirtualFunctionQuantity must be empty'],
['code' => 'InvalidParameter.EniNotBelongEcs', 'message' => 'The specified ENI does not belong to the specified ECS instance. For more information, see the actual returned result of the error message placeholder. You can call DescribeInstances to view the ENI IDs attached to the specified ECS instance.', 'http_code' => 403, 'description' => 'The specified ENI does not belong to the specified ECS instance. For more information, see the actual returned result of the error message placeholder. You can call DescribeInstances to view the ENI IDs attached to the specified ECS instance.'],
['code' => 'InvalidParameter.EniNotBelongTrunk', 'message' => 'The specified ENI does not belong to a trunk mode ENI. For more information, see the actual returned result of the error message placeholder.', 'http_code' => 403, 'description' => 'The specified ENI does not belong to a trunk mode ENI. For more information, see the actual returned result of the error message placeholder.'],
['code' => 'InvalidParameter.EniQueueSize', 'message' => 'The specified parameter "TxQueueSize" and "RxQueueSize" are not equal or the value must be 8192 or 16384.', 'http_code' => 400, 'description' => 'The queue depth of the outbound and inbound NIC is not equal or not within the allowed value range'],
['code' => 'InvalidParameter.EniTrafficMode', 'message' => 'The eni business type does not support HighPerformance traffic mode.', 'http_code' => 403, 'description' => 'The specified ENI type does not support the RDMA communication mode.'],
['code' => 'InvalidParameter.InstanceChargeType', 'message' => 'Please input a PREPAY instanceId when creating a PREPAY disk.', 'http_code' => 400, 'description' => 'You can only create a PREPAY cloud disk and attach it to a PREPAY instance.'],
['code' => 'InvalidParameter.InstanceIds', 'message' => 'The specified parameter InstanceIds is invalid.', 'http_code' => 400, 'description' => 'InstanceIds is invalid.'],
['code' => 'InvalidParameter.Invalid', 'message' => 'Specified MigrateTaskId is invalid.', 'http_code' => 400, 'description' => 'The value of the MigrateTaskId parameter is invalid.'],
['code' => 'InvalidParameter.InvalidEniQueueNumber', 'message' => 'The elastic network interface queue number is incorrect. For more information, see the actual return result of the %s placeholder in the error message.', 'http_code' => 403, 'description' => 'The elastic network interface queue number is incorrect. For more information, see the actual return result of the %s placeholder in the error message.'],
['code' => 'InvalidParameter.InvalidQueuePairNumber', 'message' => 'The number of queue pairs is invalid.', 'http_code' => 403, 'description' => 'Invalid number of queue pairs.'],
['code' => 'InvalidParameter.KeyPairNotSupported', 'message' => 'KeyPair is not supported for vNode.', 'http_code' => 400, 'description' => 'Container nodes do not support keys.'],
['code' => 'InvalidParameter.Keyword', 'message' => 'The specified parameter DBName is keyword', 'http_code' => 400, 'description' => 'The operation failed. The database name cannot contain forbidden keywords. Modify the database name. For more information, see Forbidden keywords table.'],
['code' => 'InvalidParameter.Keyword', 'message' => 'The specified parameter DBName is keyword.', 'http_code' => 400, 'description' => 'Failed to apply the parameter name. The parameter name contains the forbidden keyword DBName. Modify the parameter name. For more information, see Forbidden keywords table.'],
['code' => 'InvalidParameter.KubernetesConfig', 'message' => 'KubernetesConfig is not valid, please check labels and taints.', 'http_code' => 400, 'description' => 'KubernetesConfig field is illegal, please check Labels and Taints as OpenAPI'],
['code' => 'InvalidParameter.MaxResults', 'message' => 'The specified parameter MaxResults is not valid.', 'http_code' => 400, 'description' => 'The specified MaxResults parameter is not valid.'],
['code' => 'InvalidParameter.MinCapacity', 'message' => 'The specified parameter \'MinCapacity\' is not valid.', 'http_code' => 400, 'description' => 'The specified parameter \'MinCapacity\' is not valid.'],
['code' => 'InvalidParameter.NetworkCardIndexInvalid', 'message' => 'The network card index is invalid or the current ECS/ENI type does not support the value.', 'http_code' => 400, 'description' => 'The network card index is invalid or the current ECS/ENI type does not support the value.'],
['code' => 'InvalidParameter.NextToken', 'message' => 'The specified parameter NextToken is not valid.', 'http_code' => 400, 'description' => 'The specified NextToken parameter is not valid.'],
['code' => 'InvalidParameter.NotSupportDBInstanceStorageType', 'message' => 'Parameter DBInstanceStorageType is invalid.', 'http_code' => 400, 'description' => 'Invalid DBInstanceStorageType parameter'],
['code' => 'InvalidParameter.OwnerAccount', 'message' => 'The specified OwnerAccount is invalid.', 'http_code' => 400, 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParameter.OwnerAccount', 'message' => 'The specified parameter OwnerAccount is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParameter.PerformanceLevel', 'message' => 'PerformanceLevel is not valid, should be in PL0, PL1, PL2, PL3.', 'http_code' => 400, 'description' => 'PerformanceLevel field is illegal, its content range should be in PL0, PL1, PL2, PL3.'],
['code' => 'InvalidParameter.PriceType', 'message' => 'Specified PriceType is not valid.', 'http_code' => 400, 'description' => 'Incorrect PriceType parameters'],
['code' => 'InvalidParameter.QueuePairNumberMustEmpty', 'message' => 'When the traffic mode is set to Standard, the QueuePairNumber must be empty.', 'http_code' => 403, 'description' => 'When creating an ENI in TCP communication mode, the number of queues in RDMA mode of the ENI must be empty.'],
['code' => 'InvalidParameter.ResourceOwnerAccount', 'message' => 'The specified parameter "resourceOwnerAccount" is not valid.', 'http_code' => 400, 'description' => 'The value of the resourceOwnerAccount parameter is invalid. Specify a valid value.'],
['code' => 'InvalidParameter.ResourceOwnerId', 'message' => 'The specified parameter ResourceOwnerId is not available anymore.', 'http_code' => 403, 'description' => 'The specified parameter ResourceOwnerId is no longer available.'],
['code' => 'InvalidParameter.ScheduledRule', 'message' => 'The specified parameter ScheduledRule is not valid.', 'http_code' => 400, 'description' => 'Parameter ScheduledRule is incorrect, please re-enter'],
['code' => 'InvalidParameter.Scope', 'message' => 'The specified parameter Scope is invalid.', 'http_code' => 403, 'description' => 'The specified parameter Scope is invalid.'],
['code' => 'InvalidParameter.SecurityGroupIdRepeated', 'message' => 'The security group ID passed in is duplicate.', 'http_code' => 400, 'description' => 'The security group ID passed in is duplicate.'],
['code' => 'InvalidParameter.TagKey', 'message' => 'The Tag.N.Key parameter is invalid.', 'http_code' => 400, 'description' => 'The value of the Tag.N.Key parameter is invalid.'],
['code' => 'InvalidParameter.TagKey', 'message' => 'The Tag.N.Key parameter is invalid', 'http_code' => 400, 'description' => 'The operation failed. The value of the Tag.N.Key parameter is invalid.'],
['code' => 'InvalidParameter.TagValue', 'message' => 'The Tag.N.Value parameter is invalid.', 'http_code' => 400, 'description' => 'The Tag.N.Value parameter is invalid.'],
['code' => 'InvalidParameter.WorkingDir', 'message' => 'The specified parameter WorkingDir is not valid.', 'http_code' => 400, 'description' => 'The specified parameter WorkingDir is not valid.'],
['code' => 'InvalidParameterCharacter.CommandDescription', 'message' => 'The command Description contains illegal characters.', 'http_code' => 403, 'description' => 'The command description contains illegal characters.'],
['code' => 'InvalidParameterCharacter.CommandName', 'message' => 'The command Name contains illegal characters.', 'http_code' => 403, 'description' => 'The command name contains illegal characters.'],
['code' => 'InvalidParameterCharacter.CommandWorkingDir', 'message' => 'The command WorkingDir contains illegal characters.', 'http_code' => 403, 'description' => 'The command execution path contains illegal characters.'],
['code' => 'InvalidParameterCharset.Parameters', 'message' => 'The parameter Parameters contains illegal charset.', 'http_code' => 403, 'description' => 'The command parameter contains an illegal character set.'],
['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'],
['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'],
['code' => 'InvalidParameterGroupId.Malformed', 'message' => 'Specified parameterGroupId is not valid.', 'http_code' => 400, 'description' => 'The parameter template ID that is specified by the parameterGroupId parameter is invalid. You can call the DescribeParameterGroups operation to query the IDs of parameter templates.'],
['code' => 'InvalidParameterPaging', 'message' => 'The parameter maxRecordsPerPage or PageNumbers is invalid.', 'http_code' => 400, 'description' => 'The pagination parameters are invalid.'],
['code' => 'InvalidParameters', 'message' => 'Invalid createMode or supportCase.', 'http_code' => 400, 'description' => 'createMode or supportCase illegal.'],
['code' => 'InvalidParameters.DataDisk', 'message' => 'the data disk size is less than dataDiskSnapshotsSize.', 'http_code' => 400, 'description' => 'The size of the purchased data disk is not larger than the snapshot size of the data disk that supports mirroring.'],
['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => 'The values of some parameters are invalid.'],
['code' => 'InvalidParameters.Format', 'message' => 'The format of the specified parameter is invalid.', 'http_code' => 400, 'description' => 'The operation failed. The format of the specified parameter is invalid.'],
['code' => 'InvalidParameters.Format', 'message' => 'Specified parameter is not valid', 'http_code' => 400, 'description' => 'The operation failed. The values of some parameters are invalid.'],
['code' => 'InvalidParameters.Format', 'message' => 'The specified parameter has an invalid value.', 'http_code' => 400, 'description' => 'The operation failed because the specified parameter is invalid.'],
['code' => 'InvalidParameters.ImageId', 'message' => 'The specified image does not support the specified InstanceType.', 'http_code' => 400, 'description' => 'The specified image does not support the specified instance type.'],
['code' => 'InvalidParameters.Malformed', 'message' => 'The specified parameter "Parameters" is not valid.', 'http_code' => 400, 'description' => 'The value of the Parameters parameter is invalid. Specify a valid value.'],
['code' => 'InvalidParameters.Malformed', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => 'The value of the Parameters parameter is invalid. Specify a valid value.'],
['code' => 'InvalidParameters.Malformed', 'message' => 'One or more of the request parameters provided are not valid.', 'http_code' => 400, 'description' => 'One or more of the request parameters provided are not valid, please check the API document'],
['code' => 'InvalidParameters.Prohibited', 'message' => 'Specified parameter is not valid: %s.', 'http_code' => 400, 'description' => 'Parameter is illegal, please check.'],
['code' => 'InvalidParameters.SecurityGroupIds', 'message' => 'The SecurityGroupIds is not valid.', 'http_code' => 400, 'description' => 'An invalid security group exists in the security group list.'],
['code' => 'InvalidParameters.SystemSize', 'message' => 'SystemDisk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'],
['code' => 'InvalidParameterTemplateId', 'message' => 'The parameter templateId is invalid.', 'http_code' => 400, 'description' => 'The templateId parameter is invalid.'],
['code' => 'InvalidParameterValue.Limit', 'message' => 'Parameter value exceeds limit.', 'http_code' => 400, 'description' => 'The parameter value exceeds the limit.'],
['code' => 'InvalidParameterValue.NotStandard', 'message' => 'Invalid parameter format.', 'http_code' => 400, 'description' => 'The value of the parameter is invalid.'],
['code' => 'InvalidParamForXfs', 'message' => 'Xfs instance must be single tenant standard instance.', 'http_code' => 400, 'description' => 'Xfs instance must be single tenant standard instance.'],
['code' => 'InvalidParams.EniId', 'message' => 'The specified EniId parameter is invalid.', 'http_code' => 400, 'description' => 'The specified EniId parameter is invalid.'],
['code' => 'InvalidParams.NetworkInterfaceName', 'message' => 'The network interface name is invalid.', 'http_code' => 403, 'description' => 'Invalid ENI name'],
['code' => 'InvalidParams.RecordNotFound', 'message' => 'No records found.', 'http_code' => 404, 'description' => 'No records found.'],
['code' => 'InvalidParamTableMeta', 'message' => 'Invalid parameter TableMeta is null or not json format', 'http_code' => 400, 'description' => 'The value of the TableMeta parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidParamTableMeta.Content', 'message' => 'TableMeta missing old dbname or new dbname, please check', 'http_code' => 400, 'description' => 'The value of the table_meta parameter does not contain the names of the source and destination tables.'],
['code' => 'InvalidParamTableMeta.Content', 'message' => 'TableMeta has duplicate db.table in newname or with common.', 'http_code' => 400, 'description' => 'The table metadata contains duplicate table names.'],
['code' => 'InvalidParamTableMeta.Duplicate', 'message' => 'TableMeta has duplicate db or table with other newname, commons or system', 'http_code' => 400, 'description' => 'The operation failed. The databases and tables that you want to restore already exist in the RDS instance.'],
['code' => 'InvalidParamTableMeta.RestoreTime', 'message' => 'There are databases created later than the last full backup at the instance level, point-in-time restore is not possible, try to restore using a backup set or pick another database restore time.', 'http_code' => 403, 'description' => 'At the instance level, databases created after the last full backup exist. Point-in-time restoration cannot be performed. Use backup set restoration or select a different database restoration time.'],
['code' => 'InvalidParamTableMeta.TooManyTables', 'message' => 'At most 100 tables are supported. Restoring the database is recommended.', 'http_code' => 400, 'description' => 'The table metadata supports a maximum of 100 tables. We recommend that you restore the database instead.'],
['code' => 'InvalidParamTableMetaForRestore.Content', 'message' => 'new dbname or table in TableMeta cannot be same with old when restore to source instance.', 'http_code' => 400, 'description' => 'When data is restored to the original instance, the names of new databases and tables in TableMeta cannot be the same as those of existing databases and tables.'],
['code' => 'InvalidPassword.Malformed', 'message' => 'The specified parameter "Password" is not valid.', 'http_code' => 400, 'description' => 'The specified Password parameter is invalid.'],
['code' => 'InvalidPasswordParam.Mismatch', 'message' => 'The input password should be null when passwdInherit is true.', 'http_code' => 400, 'description' => 'The Password parameter must be empty when using the preset password.'],
['code' => 'InvalidPaymentMethod.Incomplete', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['code' => 'InvalidPaymentMethod.InsufficientBalance', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method or add funds to your Alibaba Cloud account.'],
['code' => 'InvalidPaymentMethod.Missing', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'No valid payment method is specified for your Alibaba Cloud account. Add a valid payment method.'],
['code' => 'InvalidPaymentMethod.Missing', 'message' => 'No payment method is specified for your account. Add a payment method first.', 'http_code' => 400, 'description' => 'Your payment information is incomplete. Complete your payment information and try again.'],
['code' => 'InvalidPaymentMethod.Missing', 'message' => 'Your payment method is incomplete. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'No valid payment method is specified within your Alibaba Cloud account. Add a valid payment method.'],
['code' => 'InvalidPayMethod', 'message' => 'The specified pay method is not valid.', 'http_code' => 403, 'description' => 'The payment method is invalid. Specify a valid payment method.'],
['code' => 'InvalidPayType', 'message' => 'The specified PayType is invalid.', 'http_code' => 400, 'description' => 'The specified PayType is invalid.'],
['code' => 'InvalidPayType.Format', 'message' => 'The specified parameter PayType is not valid.', 'http_code' => 400, 'description' => 'The payment type is invalid.'],
['code' => 'InvalidPayType.NotSame', 'message' => 'All primary and read-only instances should have the same payment type.', 'http_code' => 400, 'description' => 'The payment type of all primary and read-only instances should be the same.'],
['code' => 'InvalidPayType.NotSupported', 'message' => 'current instance pay type not support this operation.', 'http_code' => 400, 'description' => 'The payment type of the current instance does not support this operation.'],
['code' => 'InvalidPerformanceKey.Malformed', 'message' => 'The specified parameter Key is not valid.', 'http_code' => 400, 'description' => 'The value of the Key parameter is invalid. If the value that you specify contains multiple entries, separate the entries with commas (,). '],
['code' => 'InvalidPerformanceLevel.Malformed', 'message' => 'The specified parameter DataDisk.n.PerformanceLevel is not valid.', 'http_code' => 400, 'description' => 'The parameter PerformanceLevel of the specified data disk is invalid.'],
['code' => 'InvalidPeriod.Malformed', 'message' => 'The Specified parameter "Period" is not valid.', 'http_code' => 400, 'description' => 'Failed to create the RDS instance. The value of the Period parameter is invalid. The value of this parameter must be in the [Year,Month] format.'],
['code' => 'InvalidPort.Format', 'message' => 'Specified Port is not valid.', 'http_code' => 400, 'description' => 'The specified port is invalid.'],
['code' => 'InvalidPort.Malformed', 'message' => 'Specified port is not valid.', 'http_code' => 400, 'description' => 'The port number is invalid.'],
['code' => 'InvalidPort.Malformed', 'message' => 'The specified parameter "Port" is not valid.', 'http_code' => 400, 'description' => 'The value of the Port parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'Specified backup period is not valid.', 'http_code' => 400, 'description' => 'The backup time is invalid.'],
['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'The specified parameter "PreferredBackupPeriod" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The backup cycle is invalid.'],
['code' => 'InvalidPreferredBackupTime.Format', 'message' => 'Specified preferred backup time is not valid.', 'http_code' => 400, 'description' => 'The time of the backup file is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2012-06-11T15:00Z.'],
['code' => 'InvalidPreferredBackupTime.Malformed', 'message' => 'The specified parameter "PreferredBackupTime" is not valid.', 'http_code' => 400, 'description' => 'The backup time is invalid. The time must be in the HH:mmZ- HH:mm Z format.'],
['code' => 'InvalidPriceFault', 'message' => 'The request references an incorrect price. Contact the customer support.', 'http_code' => 403, 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['code' => 'InvalidPricePlanResult.NotFound', 'message' => 'The price plan result does not refer to the account.', 'http_code' => 403, 'description' => 'An inquiry error occurred. Please submit a ticket.'],
['code' => 'InvalidPricePlanResult.NotFound', 'message' => 'The price plan result does not refer to the account. Please check instance class.', 'http_code' => 403, 'description' => 'Failed to query the price. Submit a ticket.'],
['code' => 'InvalidPriceTaxingFault', 'message' => 'The taxing price is not correct. please contact customer service.', 'http_code' => 403, 'description' => 'An inquiry error occurred. Please submit a ticket.'],
['code' => 'InvalidPrimaryCustinsStatus', 'message' => 'Primary DBInstance status is not Active.', 'http_code' => 400, 'description' => 'The operation failed. The operation can be performed only when the primary RDS instance to which the read-only RDS instance is attached is running.'],
['code' => 'InvalidPrivateIpAddress.AlreadyUsed', 'message' => 'The specified IP is already used.', 'http_code' => 400, 'description' => 'The IP address has been used.'],
['code' => 'InvalidPrivateIpAddress.Duplicated', 'message' => 'Specified private IP address is duplicated.', 'http_code' => 400, 'description' => 'The private IP address is duplicate. The private IP address must be within the CIDR block that is supported by the specified vSwitch. If you do not specify a private IP address, the system automatically allocates a private IP address.'],
['code' => 'InvalidPrivateIpAddress.Format', 'message' => 'The specified private IP address format is incorrect.', 'http_code' => 400, 'description' => 'The specified IP address is not in the correct format.'],
['code' => 'InvalidPrivateIpAddress.Mismatch', 'message' => 'Specified private IP address is not in the CIDR block of virtual switch.', 'http_code' => 400, 'description' => 'The VPC endpoint is invalid.'],
['code' => 'InvalidPrivateIpAddress.MultipleInstancesNotSupported', 'message' => 'Specifying private IP address for multiple instances is not supported.', 'http_code' => 400, 'description' => 'The specified private IP address does not support creating multiple instances.'],
['code' => 'InvalidProxyCluster.NotFound', 'message' => 'The proxy cluster can not be found.', 'http_code' => 400, 'description' => 'The proxy instance cannot be found.'],
['code' => 'InvalidProxyCluster.NotFound', 'message' => 'The proxy cluster can not be found, please check that if ProxyClusterName exists', 'http_code' => 400, 'description' => 'The proxy instance cannot be found. Check the proxy instance.'],
['code' => 'InvalidProxyClusterName.Malformed', 'message' => 'The specified proxyClusterName is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'You must specify the proxyClusterName parameter.'],
['code' => 'InvalidProxyRole.Malformed', 'message' => 'The specified proxyRole is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'You must specify the proxyRole parameter.'],
['code' => 'InvalidProxyRole.Malformed', 'message' => 'The specified proxyRole is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The proxyRole parameter cannot be empty. Check the value of this parameter and try again.'],
['code' => 'InvalidProxyRPMVersion.NotFound', 'message' => 'The proxy ProxyRPMVersion can not be found.', 'http_code' => 400, 'description' => 'The operation failed. The version that is specified by the ProxyRPMVersion parameter cannot be found.'],
['code' => 'InvalidProxyRPMVersion.NotFound', 'message' => 'The proxy ProxyRPMVersion can not be found, please check that if ProxyRPMVersion exists', 'http_code' => 400, 'description' => 'The operation failed. The RPM version that is specified by the ProxyRPMVersion parameter cannot be found.'],
['code' => 'InvalidQuantity.NotSupported', 'message' => 'The specified instance quantity is not supported.', 'http_code' => 400, 'description' => 'The number of RDS instances exceeds the upper limit. Check the number of RDS instances.'],
['code' => 'InvalidQueryKeyword.Malformed', 'message' => 'the query key contains exception character.', 'http_code' => 400, 'description' => 'The query failed. The keyword that is used for the query is invalid.'],
['code' => 'InvalidQueryTime.Format', 'message' => 'he specified parameter "QueryTime" is not valid.', 'http_code' => 400, 'description' => 'The value of the QueryTime parameter is invalid.'],
['code' => 'InvalidQueryTime.Format', 'message' => 'Specified query time is not valid.', 'http_code' => 400, 'description' => 'The query time is invalid.'],
['code' => 'InvalidQueryTimeRange', 'message' => 'The query time range is invalid.', 'http_code' => 400, 'description' => 'Invalid query time range'],
['code' => 'InvalidRandomZone.NotFound', 'message' => 'There is no random zone for on ecs class code.', 'http_code' => 403, 'description' => 'Failed to allocate zones at random.'],
['code' => 'InvalidRandomZone.NotFound', 'message' => 'There is no random zone available.', 'http_code' => 403, 'description' => 'No suitable random zone was found.'],
['code' => 'InvalidRCDeploymentName.NotFound', 'message' => 'The RDS deployment set cannot be found. Check the values of the request parameters.', 'http_code' => 400, 'description' => 'The specified deployment set was not found. Check the correctness of the deployment set.'],
['code' => 'InvalidRCInstanceID.NotFound', 'message' => 'The specified custom instanceID is not valid.', 'http_code' => 400, 'description' => 'The passed instance ID does not belong to the custom instance.'],
['code' => 'InvalidRCInstanceName.NotFound', 'message' => 'The RDS Custom instance was not found.', 'http_code' => 404, 'description' => 'RDS Custom instance not found.'],
['code' => 'InvalidRCUValue', 'message' => 'scaleMin and scaleMax range is not valid.', 'http_code' => 400, 'description' => 'Invalid scaleMin and scaleMax range.'],
['code' => 'InvalidReadDBInstance.NotFound', 'message' => 'The specified read only database instance does not exist.', 'http_code' => 404, 'description' => 'The read-only RDS instance is not created, or the values of the request parameters are invalid.'],
['code' => 'InvalidReadDBInstanceName.NotFound', 'message' => 'The specified read instance name does not exist.', 'http_code' => 404, 'description' => 'The read-only RDS instance cannot be found.'],
['code' => 'InvalidReadDBInstanceStorage.Format', 'message' => 'Specified Storage is not valid, Read DB Instance storage size must be greater than or equal to primary DB Instance.', 'http_code' => 400, 'description' => 'The read-only DB instance storage size must be greater than or equal to the primary DB instance.'],
['code' => 'InvalidReadEngineVersionPattern', 'message' => 'The engine versions of the primary instance and the read-only instance do not match.', 'http_code' => 400, 'description' => 'The engineVersion of the primary instance and the read-only instance do not match.'],
['code' => 'InvalidReadOnlyDBInstanceClass.NotSupport', 'message' => 'The target read-only db instance class can not lower than the original read-only db instance class.', 'http_code' => 400, 'description' => 'the target specifications of the read-only instance must be no less than the original specifications (including cpu and memory).'],
['code' => 'InvalidReadStorageTypePattern', 'message' => 'The storage types of the primary instance and the read-only instance do not match.', 'http_code' => 403, 'description' => 'The storage type of the primary instance and the read-only instance do not match.'],
['code' => 'InvalidReadStorageTypePattern', 'message' => 'The storage type of the primary instance and the read-only instance do not match.', 'http_code' => 400, 'description' => 'The storage type of the primary instance and the read-only instance do not match.'],
['code' => 'InvalidRecoveryDbInstance.StorageSize', 'message' => 'The disk space of the new instance cannot be less than that of the current instance', 'http_code' => 400, 'description' => 'The operation failed. The available storage space of the new RDS instance must be greater than or equal to the total size of data stored in the original RDS instance.'],
['code' => 'InvalidRecoveryDbInstance.StorageSize', 'message' => 'The disk space of the new instance cannot be less than that of the current instance.', 'http_code' => 400, 'description' => 'The operation failed. The disk space of the new instance cannot be less than the space of the current instance.'],
['code' => 'InvalidRecoveryDbInstance.StorageType', 'message' => 'The disk local_ssd can not clone to cloud disk type', 'http_code' => 400, 'description' => 'A local disk cannot be cloned to a cloud disk.'],
['code' => 'InvalidRecoveryDBNames.Format', 'message' => 'The specified parameter DBNames is not valid.', 'http_code' => 400, 'description' => 'The instance name is invalid. Check the instance name.'],
['code' => 'InvalidReduceDiskSize', 'message' => 'The storage capacity after the scale-down must be larger than the used amount.', 'http_code' => 403, 'description' => 'The scale-in target capacity cannot be less than the current storage space usage'],
['code' => 'InvalidRegion.Format', 'message' => 'Specified Region is not valid.', 'http_code' => 400, 'description' => 'The region ID is invalid. Check the region ID.'],
['code' => 'InvalidRegion.NotFound', 'message' => 'Specified Region does not exist in the RDS', 'http_code' => 404, 'description' => 'The region ID is invalid.'],
['code' => 'InvalidRegion.NotFound', 'message' => 'The specified region is not found.', 'http_code' => 404, 'description' => 'The region ID is invalid.'],
['code' => 'InvalidRegion.NotFound', 'message' => 'Specified Region does not exist in RDS.', 'http_code' => 400, 'description' => 'Specified Region does not exist in RDS.'],
['code' => 'InvalidRegion.NotSupport', 'message' => 'the specified instance region does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'InvalidRegion.NotSupported', 'message' => 'The specified parameter Regionis not valid.', 'http_code' => 400, 'description' => 'The current Region parameter is invalid. Set a valid Region parameter.'],
['code' => 'InvalidRegion.ValueNotSupported', 'message' => 'The specified parameter "Region" is not valid.', 'http_code' => 400, 'description' => 'The region information failed the verification check. Check the region information.'],
['code' => 'InvalidRegionAvzNotFound', 'message' => 'Specified user does not find the region and avz.', 'http_code' => 403, 'description' => 'The specified user does not have an associated region or availability zone.'],
['code' => 'InvalidRegionId.MalFormed', 'message' => 'The specified parameter RegionId is not valid.', 'http_code' => 400, 'description' => 'The specified RegionId is illegal.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId is not found.', 'http_code' => 404, 'description' => 'The region ID cannot be found. Check the region ID.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId does not exist in our records.', 'http_code' => 404, 'description' => 'The region ID cannot be found. Check the region ID.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId provided does not exist.', 'http_code' => 404, 'description' => 'This region does not exist. Configure the region again.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The DBInstanceId provided does not exist.', 'http_code' => 404, 'description' => 'The instance ID cannot be found. Modify the instance ID and try again.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The instance ID cannot be found. Modify the instance ID and try again.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId does not exist in our records.', 'http_code' => 404, 'description' => 'The operation failed. The region and the zone cannot be found.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The provided RegionId does not exist.', 'http_code' => 404, 'description' => 'The specified region ID is not found. Please check again.'],
['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The provided RegionId does not exist in our records.'],
['code' => 'InvalidRegionLimitFault', 'message' => 'The specified region does not support to creating guard instance.', 'http_code' => 404, 'description' => 'You cannot create a protected RDS instance in the region.'],
['code' => 'InvalidRegionZoneNotFound', 'message' => 'Specified Region does not exist in RDS.', 'http_code' => 400, 'description' => 'Specified Region does not exist in RDS.'],
['code' => 'InvalidReleasedKeepPolicy.Format', 'message' => 'Specified Released Keep Policy is not valid.', 'http_code' => 400, 'description' => 'Specified Released Keep Policy is not valid.'],
['code' => 'InvalidRenewalDuration.Malformed', 'message' => 'The specified parameter Duration is not valid.', 'http_code' => 400, 'description' => 'The value of the Duration parameter is invaild.'],
['code' => 'InvalidRepeatMode.NotFound', 'message' => 'The specified repeat mode does not exist.', 'http_code' => 404, 'description' => 'The specified command execution mode does not exist.'],
['code' => 'InvalidReportType.Format', 'message' => 'Specified report type is not valid.', 'http_code' => 400, 'description' => 'The report type is invalid.'],
['code' => 'InvalidRequestId', 'message' => 'The request is copy, check your token.', 'http_code' => 400, 'description' => 'The request is copy, check your token.'],
['code' => 'InvalidRequestToken', 'message' => 'The request is duplicate, please check your token.', 'http_code' => 400, 'description' => 'The request is duplicate, please check your token.'],
['code' => 'InvalidReserveAccount.Format', 'message' => 'Specified ReserveAccount is not valid.', 'http_code' => 400, 'description' => 'The specified ReserveAccount is invalid.'],
['code' => 'InvalidResource.Format', 'message' => 'The specified parameter Resource is not valid.', 'http_code' => 400, 'description' => 'The resource ID is invalid.'],
['code' => 'InvalidResourceGroup.NotFound', 'message' => 'The ResourceGroup provided does not exist in our records.', 'http_code' => 404, 'description' => 'The resource group is not in the record.'],
['code' => 'InvalidResourceId.NotFound', 'message' => 'ResourceId does not refer to an existing DB instance.', 'http_code' => 400, 'description' => 'The operation failed. The value of the ResourceId parameter is not the ID of an existing RDS instance.'],
['code' => 'InvalidResourceId.NotFound', 'message' => 'The specified ResourceId is not found in our records.', 'http_code' => 404, 'description' => 'The specified ResourceId is not found in our records. Please check if the resource is correct.'],
['code' => 'InvalidResourceTag.ConflictWithInstanceIds', 'message' => 'The specified param ResourceTag conflicts with InstanceId.', 'http_code' => 400, 'description' => 'The specified parameter ResourceTag conflict with the InstanceId.'],
['code' => 'InvalidResourceTag.InstanceNotFound', 'message' => 'InstanceIds are not found by the specified ResourceTag.', 'http_code' => 400, 'description' => 'The instance ID was not found for the specified ResourceTag.'],
['code' => 'InvalidResourceTagKey.Malformed', 'message' => 'The specified ResourceTag key is not valid.', 'http_code' => 400, 'description' => 'The specified ResourceTag key is not valid.'],
['code' => 'InvalidResourceTagValue.Malformed', 'message' => 'The specified ResourceTag value is not valid.', 'http_code' => 400, 'description' => 'The specified ResourceTag value is not valid.'],
['code' => 'InvalidRestartPolicy.Format', 'message' => 'Specified Restart Policy is not valid.', 'http_code' => 403, 'description' => 'The specified restart policy is invalid.'],
['code' => 'InvalidRestoreDB', 'message' => 'Unable to restore, because the database is in cold storage now. Please skip this database.', 'http_code' => 400, 'description' => 'Unable to restore, because the database is in cold storage now. Please skip this database.'],
['code' => 'InvalidRestoreTime', 'message' => 'The param TempUpgradeRestoreTime is invalid.', 'http_code' => 400, 'description' => 'The RestoreTime parameter is invalid.'],
['code' => 'InvalidRestoreTime.Format', 'message' => 'Specified restore time is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The point in time is invalid. Specify a valid point in time.'],
['code' => 'InvalidRestoreTime.Malformed', 'message' => 'The specified retain instance is not valid.', 'http_code' => 400, 'description' => ' '],
['code' => 'InvalidRestoreTime.Malformed', 'message' => 'The specified parameter "RestoreTime" is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The time format is invalid. 1. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. Example: 2017-05-30T03:29:10. 2. If you back up or clone the RDS instance, also check whether a data backup file can be found at the specified point in time.'],
['code' => 'InvalidRestoreTime.Malformed', 'message' => 'The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.', 'http_code' => 400, 'description' => 'The requested restoreTime parameter is invalid, or the requested restoreTime is not within the backup range of the instance.'],
['code' => 'InvalidRestoreTimeSpecified', 'message' => 'Unable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.', 'http_code' => 400, 'description' => 'Unable to restore to the specified time, because the database is in cold storage at this time. Please choose a valid restore point.'],
['code' => 'InvalidRestoreType.Format', 'message' => 'Specified restore type is not valid.', 'http_code' => 400, 'description' => 'The restoration type is invalid. Specify a valid restoration type.'],
['code' => 'InvalidRetainInstance.Format', 'message' => 'Specified retain instance is not valid.', 'http_code' => 400, 'description' => 'The value of the RestoreTime parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidRPMVersion.Malformed', 'message' => 'The specified RPMVersion is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'The RPM version cannot be left unspecified. Specify the RPM version and try again.'],
['code' => 'InvalidRPMVersion.Malformed', 'message' => 'The specified RPMVersion is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The operation failed. The RPM version cannot be empty. Specify a RPM version and try again.'],
['code' => 'InvalidRWSplitClassicExpiredDays', 'message' => 'The request is missing a RWSplitClassicExpiredDays parameter or parameter not between 1 ~ 60.', 'http_code' => 404, 'description' => 'The RWSplitClassicExpiredDays parameter is not specified or the value of this parameter is not within 1 to 60.'],
['code' => 'InvalidRwSplitNetType.NotFound', 'message' => 'The RwSplitNetType is not found.', 'http_code' => 404, 'description' => 'The operation failed. Create an RDS instance for which read/write splitting is enabled and try again.'],
['code' => 'InvalidSaleBusinessFault', 'message' => 'The request not refer to the correct order sales business. please contact customer service.', 'http_code' => 400, 'description' => 'An inquiry error occurred. Contact Alibaba Cloud customer service.'],
['code' => 'InvalidSaleComponentFault', 'message' => 'The request not refer to the correct order sale component. please contact customer service.', 'http_code' => 403, 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['code' => 'InvalidSalePriceFault', 'message' => 'The request not refer to the correct order price. please contact customer service.', 'http_code' => 400, 'description' => 'Failed to query the price. Contact your customer service representatives.'],
['code' => 'InvalidScope', 'message' => 'The specified scope is invalid', 'http_code' => 400, 'description' => 'The specified scope is invalid.'],
['code' => 'InvalidSearchTimeRange', 'message' => 'The search time range cannot be longer than a month.', 'http_code' => 400, 'description' => 'The interval between the start time and the end time must be less than 31 days. Check the values of the StartTime parameter and the EndTime parameter.'],
['code' => 'InvalidSearchTimeRange', 'message' => 'search time range cannot be longer than a month.', 'http_code' => 400, 'description' => 'The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters.'],
['code' => 'InvalidSecurityGroupId.DuplicateId', 'message' => 'The specified parameter SecurityGroupIds has duplicateId.', 'http_code' => 400, 'description' => 'The specified security group list has duplicate'],
['code' => 'InvalidSecurityGroupId.NotFound', 'message' => 'The specified SecurityGroupId does not found.', 'http_code' => 403, 'description' => 'The security group that is specified by the SecurityGroupId parameter cannot be found. The security group and the RDS instance do not belong to the same region.'],
['code' => 'InvalidSecurityGroupId.NotFound', 'message' => 'The specified security group ID does not exist.', 'http_code' => 404, 'description' => 'The specified security group ID does not exist.'],
['code' => 'InvalidSecurityGroupId.NotVpc', 'message' => 'The parameter SecurityGroupId is invalid. The network type of the security group is not VPC.', 'http_code' => 403, 'description' => 'The parameter SecurityGroupId is invalid. The network type of the security group is not VPC.'],
['code' => 'InvalidSecurityGroupId.SingleIdAndMultiIdConflict', 'message' => 'Security group ID Single ID conflicts with multiple IDs.', 'http_code' => 400, 'description' => 'Security group ID Single ID conflicts with multiple IDs'],
['code' => 'InvalidSecurityGroupId.SingleIdAndMultiIdConflict', 'message' => 'The specified parameter not support to set SecurityGroupId and SecurityGroupIds at the same time.', 'http_code' => 400, 'description' => 'The security group and security group list cannot be set at the same time.'],
['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list.', 'http_code' => 400, 'description' => 'The IP address whitelist is invalid. It contains duplicate entries.'],
['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'The Security IP address is not in the available range or occupied.', 'http_code' => 400, 'description' => 'The IP address is invalid. Specify a valid IP address.'],
['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'http_code' => 400, 'description' => 'The IP address whitelist is invalid. The whitelist contains duplicate entries.'],
['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => 400, 'description' => 'The IP address whitelist is invalid. Check the IP address whitelist.'],
['code' => 'InvalidSecurityIPList.Format', 'message' => 'The specified parameter securityIPList is not valid.', 'http_code' => 400, 'description' => 'The format of the IP address whitelist does not meet the requirements. Check the IP address whitelist.'],
['code' => 'InvalidSecurityIPList.Malformed', 'message' => 'The specified parameter SecurityIPList is not valid.', 'http_code' => 400, 'description' => 'The IP address whitelist of the RDS instance is invalid.'],
['code' => 'InvalidSecurityIPList.Malformed', 'message' => 'The specified parameter "SecurityIPList" is not valid.', 'http_code' => 400, 'description' => 'The IP address whitelist of the RDS instance is invalid.'],
['code' => 'InvalidSecurityIPList.QuotaExceeded', 'message' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'http_code' => 400, 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist that is specified by the SecurityIPList parameter exceeds the upper limit. The IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks.'],
['code' => 'InvalidSecurityIPListGroup.QuotaExceeded', 'message' => 'Specified security IP list group is not valid: Exceeding the allowed amount of group.', 'http_code' => 400, 'description' => 'The specified whitelist security group is invalid and exceeds the number of allowed groups.'],
['code' => 'InvalidSecurityIPListLength.Malformed', 'message' => 'The security ip address is not in the available range or occupied.', 'http_code' => 404, 'description' => 'The IP address is invalid.'],
['code' => 'InvalidSecurityIPListLength.Malformed', 'message' => 'The quota of security ip exceeds.', 'http_code' => 400, 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist reaches the upper limit.'],
['code' => 'InvalidSecurityIps.MalFormed', 'message' => 'The specified parameter "SecurityIps" is not valid.', 'http_code' => 400, 'description' => 'The IP address whitelist is invalid. An IP address whitelist can contain %, 0.0.0.0/0, or up to 1,000 IP addresses (for example, 10.23.12.24) and CIDR blocks (for example, 10.23.12.24/24). The 0.0.0.0/0 entry indicates that all IP addresses are granted access to the RDS instance. In the CIDR example provided, /24 indicates that the prefix of each IP address in the CIDR block contains 24 bits in length. You can replace 24 with an integer within the range of 1 to 32.'],
['code' => 'InvalidSecurityIPs.NotFound', 'message' => 'The specified security ip list has no matching value or at least one security IP is needed.', 'http_code' => 404, 'description' => 'The IP address cannot be found in any IP address whitelist of the RDS instance. Log on to the ApsaraDB RDS console and go to the Database Security page of the RDS instance to check the IP address whitelists of the RDS instance.'],
['code' => 'InvalidSecurityIpType.Format', 'message' => 'The format of the security IP type is invalid.', 'http_code' => 400, 'description' => 'The specified SecurityIPType parameter is invalid. 1) Multiple IP addresses or CIDR blocks must be separated by commas (,), and no spaces are allowed preceding or following the commas (,). 2) Up to 1,000 IP addresses or CIDR blocks can be specified for each instance. If you need to specify a large number of IP addresses, we recommend that you merge appropriate IP addresses into CIDR blocks.'],
['code' => 'InvalidSecurityToken.Expired', 'message' => 'Specified SecurityToken is expired.', 'http_code' => 403, 'description' => 'The signature expired. Use a new signature.'],
['code' => 'InvalidServerCertOrPrivateKey', 'message' => 'Specify server certificate or private key is invalid.', 'http_code' => 400, 'description' => 'The server certificate type or the private key is invalid.'],
['code' => 'InvalidServerlessParam', 'message' => 'serverless config param not valid.', 'http_code' => 400, 'description' => 'The Serverless configuration parameter is invalid.'],
['code' => 'InvalidServiceType.Format', 'message' => 'Specified service type is not valid.', 'http_code' => 400, 'description' => 'The service type is invalid. Set the service type to 0 or 1. The value 0 indicates an Alibaba Cloud service, and the value 1 indicates a JST service.'],
['code' => 'InvalidShareDbInstanceClassNotSupport', 'message' => 'The current instance classType is not support operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the specified instance type.'],
['code' => 'InvalidShareInstance.NotSupport', 'message' => 'The share dbInstance is not support.', 'http_code' => 400, 'description' => 'This operation is not supported for shared instances.'],
['code' => 'InvalidSiteList.Malformed', 'message' => 'The specified siteList is not valid. It can not be empty string.', 'http_code' => 400, 'description' => 'The value of the siteList parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidSiteList.Malformed', 'message' => 'The specified siteList is not valid. It can not be empty string', 'http_code' => 400, 'description' => 'The value of the siteList parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidSnapshot.Malformed', 'message' => 'The specified eed category does not support snapshot operation.', 'http_code' => 400, 'description' => 'Elastic temporary disks do not support snapshot recovery or snapshot creation.'],
['code' => 'InvalidSnapshotIds.Malformed', 'message' => 'The specified snapshotId is not valid.', 'http_code' => 400, 'description' => 'the specified snapshot id is invalid, and the information of the user snapshot id is not obtained.'],
['code' => 'InvalidSortKey.Malformed', 'message' => 'The specified parameter "SortKey" is not valid.', 'http_code' => 404, 'description' => 'The value of the SortKey parameter failed the verification check. Check the criteria based on which ApsaraDB RDS sorts data. The supported criteria are CPU_Usage, IOPS_Usage, Disk_Usage, and Session_Usage. The default criterion is CPU_Usage.'],
['code' => 'InvalidSortMethod.Malformed', 'message' => 'The specified parameter "SortMethod" is not valid.', 'http_code' => 400, 'description' => 'The value of the SortMethod parameter failed the verification check. '."\n"
.'Valid values: ASC and DESC.'."\n"
.'Default value: DESC. The default value indicates the descending order.'],
['code' => 'InvalidSourceCategory', 'message' => 'specified source category is invalid.', 'http_code' => 400, 'description' => 'The specified source category is invalid.'],
['code' => 'InvalidSourceDatabasePort.Malformed', 'message' => 'The specified parameter \'SourceDatabasePort\' is not valid.', 'http_code' => 400, 'description' => 'The value of the SourceDatabasePort parameter is invalid.'],
['code' => 'InvalidSourceDatabasePort.Malformed', 'message' => 'The specified parameter SourceDatabasePort is not valid.', 'http_code' => 400, 'description' => 'The value of the SourceDatabasePort parameter is invalid. Specify a valid value.'],
['code' => 'InvalidSourceDatabaseUserNameOrSourceDatabasePassword.Malformed', 'message' => 'The specified parameter "SourceDatabaseUserName" or "SourceDatabasePassword" is not valid.', 'http_code' => 400, 'description' => 'The value of the SourceDatabaseUserName parameter or the value of the SourceDatabasePassword parameter is invalid. Specify valid values.'],
['code' => 'InvalidSourceDBInstance.NotFound', 'message' => 'The specified source instance does not exist or not support.', 'http_code' => 404, 'description' => 'The operation failed. The source RDS instance cannot be found or does not support this operation.'],
['code' => 'InvalidSourceIp', 'message' => 'Specified sourceIp is invalid.', 'http_code' => 403, 'description' => 'The specified SourceIp parameter is invalid.'],
['code' => 'InvalidSourceRestoreDBName.NotFound', 'message' => 'specific source restore dbname is not found in db list', 'http_code' => 400, 'description' => 'The operation failed. The data backup file does not contain the data of the databases.'],
['code' => 'InvalidSQLCollectorStatus.Malformed', 'message' => 'The specified parameter "SQLCollectorStatus" is not valid.', 'http_code' => 400, 'description' => 'The value of the parameter that controls the status of the SQL Explorer feature is invalid. Valid values: Enable and Disable.'],
['code' => 'InvalidSQLCollectorStatus.ValueNotSupported', 'message' => 'The specified SQLCollectorStatus value not support.', 'http_code' => 400, 'description' => 'The value of the SQL CollectorStatus parameter is invalid. Check the value of this parameter.'],
['code' => 'InvalidSqlLog.Malformed', 'message' => 'The specified parameter SqlLog is not valid.', 'http_code' => 400, 'description' => 'The SqlLog parameter is invalid.'],
['code' => 'InvalidSqlRetention.Malformed', 'message' => 'Specified sql retention is not valid.', 'http_code' => 403, 'description' => 'The specified SQL retention is invalid.'],
['code' => 'InvalidSSLStatus', 'message' => 'Specify ssl status is invalid.', 'http_code' => 400, 'description' => 'The operation failed. The setting of SSL encryption is invalid.'],
['code' => 'InvalidSSLstatus', 'message' => 'Current DB instance has SSL enabled, this operation is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported because this instance has SSL enabled.'],
['code' => 'InvalidStartTime.Format', 'message' => 'The specified parameter "StartTime" is not valid.', 'http_code' => 400, 'description' => 'The start time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. For example, you can set the start time to 2012-06-11T15:00Z in the DescribeDBInstancePerformance operation and set the start time to 2011-06-11T16:00Z in the DescribeErrorLogs operation.'],
['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => 'The start time is invalid.'],
['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter "StartTime" is not valid.', 'http_code' => 403, 'description' => 'The start time is invalid. Specify the time in the GMT standard in the YYYY-MM-DDThh:mmZ format. For example, you can set the start time to 2012-06-11T15:00Z in the DescribeDBInstancePerformance operation and set the start time to 2011-06-11T16:00Z in the DescribeErrorLogs operation.'],
['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter "StartTime" is not valid.', 'http_code' => 403, 'description' => 'The value of the StartTime parameter is invalid. Specify a valid value.'],
['code' => 'InvalidStartTimeAndEndTime.MalFormed', 'message' => 'The EndTime must be later than or equal to the StartTime.', 'http_code' => 404, 'description' => 'The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.'],
['code' => 'InvalidStartTimeAndEndTime.Malformed', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => 'The operation failed. The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.'],
['code' => 'InvalidStartTimeAndEndTime.Malformed', 'message' => 'The end time must be greater than the start time', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'],
['code' => 'InvalidStatus.ResourceGroup', 'message' => 'You cannot perform an operation on a resource group that is being created or deleted.', 'http_code' => 403, 'description' => 'Operation not allowed while resource group is being created or deleted.'],
['code' => 'InvalidStorage', 'message' => 'specified Engine or Engine version cannot reduce instance storage.', 'http_code' => 400, 'description' => 'The specified engine or engine version cannot reduce instance storage.'],
['code' => 'InvalidStorage.Format', 'message' => 'The specified storage is not valid.', 'http_code' => 400, 'description' => 'The value of the Storage parameter is invalid. Specify a valid value.'],
['code' => 'InvalidStorage.Format', 'message' => 'Specified Storage is not valid.', 'http_code' => 400, 'description' => 'The value of the Storage parameter is invalid. Specify a valid value.'],
['code' => 'InvalidStorage.Malformed', 'message' => 'The specified Storage is not valid.', 'http_code' => 400, 'description' => 'The value of the Storage parameter is invalid. Specify a valid value.'],
['code' => 'InvalidStorageSize.CannotChange', 'message' => '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.', 'http_code' => 400, 'description' => 'The storage size cannot be modified in the current operation. If you need to modify the disk type, use other operations to modify the size of the target disk. The size of the target disk must meet the limit of the target disk type.'],
['code' => 'InvalidStorageSize.ConstraintUnsatisfied', 'message' => '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.', 'http_code' => 400, 'description' => 'The current storage space of the primary or read-only instance does not meet the storage space constraint DBInstanceStorageType by the target disk type. Please modify the storage space size of the instance separately before implementing the local disk cross-cloud disk operation.'],
['code' => 'InvalidStorageSize.Direction', 'message' => 'The specified parameter StorageSize does not meet the updating direction constraint requirements.', 'http_code' => 400, 'description' => 'The storage space does not meet the constraint requirements of the current change direction.'],
['code' => 'InvalidStorageType.Direction', 'message' => 'The specified parameter StorageType does not meet the updating direction constraint requirements.', 'http_code' => 400, 'description' => 'The storage type does not satisfy the change direction constraint.'],
['code' => 'InvalidStorageType.NotSupport', 'message' => 'The current storage type does not support this operation.', 'http_code' => 400, 'description' => 'The current storage type does not support this operation.'],
['code' => 'InvalidSwitchMode.NotFound', 'message' => 'Specified Parameter UpgradeTime is Invalid.', 'http_code' => 400, 'description' => 'The switchover mode is unknown.'],
['code' => 'InvalidSwitchOver', 'message' => 'The specified SwitchOver is invalid.', 'http_code' => 400, 'description' => 'The specified SwitchOver parameter is invalid.'],
['code' => 'InvalidSwitchTime', 'message' => 'The specified SwitchTime is invalid.', 'http_code' => 400, 'description' => 'The specified SwitchTime parameter is invalid.'],
['code' => 'InvalidSwitchTime.Format', 'message' => 'Specified switch time is not valid.', 'http_code' => 400, 'description' => 'The switching time is invalid.'],
['code' => 'InvalidSwitchTime.Format', 'message' => 'The specified switch time is not valid.', 'http_code' => 403, 'description' => 'The operation failed. The switching time is invalid.'],
['code' => 'InvalidSwitchTimeMode', 'message' => 'The specified SwitchTimeMode is invalid.', 'http_code' => 400, 'description' => 'The specified SwitchTimeMode parameter is invalid.'],
['code' => 'InvalidSwitchType.Malformed', 'message' => 'The specified parameter InvalidSwitchType is not valid.', 'http_code' => 403, 'description' => 'The value of the InvalidSwitchType parameter is invalid.'],
['code' => 'InvalidSyncMode.Malformed', 'message' => 'The specified parameter SyncMode is not valid.', 'http_code' => 403, 'description' => 'The parameter SyncMode is invalid. Check the parameter again.'],
['code' => 'InvalidSystemDiskCategory.ValueNotSupported', 'message' => 'The current operation does not support this system disk type.', 'http_code' => 400, 'description' => 'The current operation does not support this system disk type.'],
['code' => 'InvalidTag.1.key.Malformed', 'message' => 'The specified parameter \'Tag.1.key\' is not valid.', 'http_code' => 400, 'description' => 'The key that is specified by the Tag.1.key parameter failed the verification check.'],
['code' => 'InvalidTag.1.value.Malformed', 'message' => 'The specified parameter \'Tag.1.value\' is not valid.', 'http_code' => 400, 'description' => 'Failed to configure the tag.'],
['code' => 'InvalidTag.2.key.Malformed', 'message' => 'The specified parameter \'Tag.2.key\' is not valid.', 'http_code' => 400, 'description' => 'The key or value of the tag is invalid.'],
['code' => 'InvalidTag.2.value.Malformed', 'message' => 'The specified parameter \'Tag.2.value\' is not valid.', 'http_code' => 400, 'description' => 'The value of the Tag.2.value parameter is invalid.'],
['code' => 'InvalidTag.3.key.Malformed', 'message' => 'The specified parameter \'Tag.3.key\' is not valid.', 'http_code' => 400, 'description' => 'The operation failed. The key that is specified by the Tag.3.key parameter failed the verification check. Specify a valid key.'],
['code' => 'InvalidTag.3.value.Malformed', 'message' => 'The specified parameter \'Tag.3.value\' is not valid.', 'http_code' => 400, 'description' => 'The settings of the tag are invalid.'],
['code' => 'InvalidTag.4.key.Malformed', 'message' => 'The specified parameter \'Tag.4.key\' is not valid.', 'http_code' => 400, 'description' => 'The key of the tag failed the verification check. Check the value of the Tag.4.key parameter. The value of a tag can be empty, but the key of a tag cannot be empty.'],
['code' => 'InvalidTag.4.value.Malformed', 'message' => 'The specified parameter \'Tag.4.value\' is not valid.', 'http_code' => 400, 'description' => 'The value of the tag failed the verification check. Specify a valid tag value.'],
['code' => 'InvalidTag.5.key.Malformed', 'message' => 'The specified parameter \'Tag.5.key\' is not valid.', 'http_code' => 400, 'description' => 'Failed to configure the tag.'],
['code' => 'InvalidTag.5.value.Malformed', 'message' => 'The specified parameter \'Tag.5.value\' is not valid.', 'http_code' => 400, 'description' => 'The key or value of the tag is invalid.'],
['code' => 'InvalidTagKey.Malformed', 'message' => 'Malformed tag key.', 'http_code' => 401, 'description' => 'The format of tag key is invalid.'],
['code' => 'InvalidTagKey.Malformed', 'message' => 'The Tag.N.Key parameter is blank', 'http_code' => 400, 'description' => 'The operation failed. The Tag.N.Key parameter is empty.'],
['code' => 'InvalidTagKey.Malformed', 'message' => 'The operator is not permission for the system tag', 'http_code' => 400, 'description' => 'The operation failed. You do not have permissions on system tags.'],
['code' => 'InvalidTagKey.Malformed', 'message' => 'The Tag.N.Key parameter is empty.', 'http_code' => 400, 'description' => 'The Tag.N.Key parameter is left unspecified.'],
['code' => 'InvalidTagKey.Malformed', 'message' => 'The specified Tag.n.Key is not valid.', 'http_code' => 400, 'description' => 'The specified tag key parameter is incorrect.'],
['code' => 'InvalidTagValue.Malformed', 'message' => 'The Tag.N.Value parameter is blank', 'http_code' => 400, 'description' => 'The Tag.N.Value is empty.'],
['code' => 'InvalidTagValue.Malformed', 'message' => 'The Tag.N.Value parameter is empty.', 'http_code' => 400, 'description' => 'The Tag.N.Value parameter is left unspecified.'],
['code' => 'InvalidTagValue.Malformed', 'message' => 'The Tag.N.Value parameter is invalid.', 'http_code' => 400, 'description' => 'The Tag.N.Value parameter is invalid.'],
['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified Tag.n.Value is not valid.', 'http_code' => 400, 'description' => 'The specified tag value parameter is invalid.'],
['code' => 'InvalidTargetAvailabilityZone', 'message' => 'All endpoint vswitchId must be in the target availability zone.', 'http_code' => 400, 'description' => 'The vswitchId of all connection addresses must be in the target Availability Zone.'],
['code' => 'InvalidTargetCategory', 'message' => 'Specified classCode is not matched with current product type.', 'http_code' => 400, 'description' => 'The specified classCode does not match the current product type.'],
['code' => 'InvalidTargetDBInstanceName.Format', 'message' => 'Specified Target DB instance name is not valid.', 'http_code' => 403, 'description' => 'The name of the destination instance is invalid.'],
['code' => 'InvalidTargetDBInstanceName.NotFound', 'message' => 'The specified DB instance name does not exist.', 'http_code' => 400, 'description' => 'The specified database instance name does not exist.'],
['code' => 'InvalidTargetDedicatedHostId.NotFound', 'message' => 'The target dedicated host ID is invalid.', 'http_code' => 400, 'description' => 'The host ID is invalid. Check the host ID and make sure that the host is available.'],
['code' => 'InvalidTargetStorageType', 'message' => 'The storage type cannot be changed when the instance type or storage size is changed.', 'http_code' => 403, 'description' => 'The storage type cannot be changed from general ESSD to ESSD.'],
['code' => 'InvalidTargetStorageType', 'message' => 'can not change storage type from general essd to essd.', 'http_code' => 400, 'description' => 'The storage type cannot be changed from general ESSD to ESSD.'],
['code' => 'InvalidTask.NotFound', 'message' => 'Specified MigrateTaskId could not be found on RDS.', 'http_code' => 400, 'description' => 'No migration task ID is found in RDS.'],
['code' => 'InvalidTask.NotFound', 'message' => 'specified task does not exist.', 'http_code' => 404, 'description' => 'The specified task does not exist.'],
['code' => 'InvalidTaskId.Format', 'message' => 'The parameter TaskId is required.', 'http_code' => 400, 'description' => 'The parameter TaskId is required.'],
['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => 'The task ID cannot be found. Check the task ID.'],
['code' => 'InvalidTaskId.NotFound', 'message' => 'The "ImportId" is not found.', 'http_code' => 400, 'description' => 'The operation failed. The ID of the import task is invalid. Check the ID of the import task.'],
['code' => 'InvalidTaskStatus', 'message' => 'Current task status (Terminated/Failed) does not support.', 'http_code' => 400, 'description' => 'The current task status (Stopped) does not support the operation.'],
['code' => 'InvalidTaskType', 'message' => 'specified task type is invalid.', 'http_code' => 400, 'description' => 'The specified task type is invalid.'],
['code' => 'InvalidTaskType.Invalid', 'message' => 'Migrate task type Incremental is not supported, only support FULL backup migrate task.', 'http_code' => 400, 'description' => 'The incremental migration task type is not supported. Only complete backup migration task is supported.'],
['code' => 'InvalidTDEKey', 'message' => 'Kms key is disabled.', 'http_code' => 400, 'description' => 'The Kms key has been disabled.'],
['code' => 'InvalidTDEstatus', 'message' => 'Current DB instance has TDE enabled, this operation is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported because TDE is enabled on the instance.'],
['code' => 'InvalidTDEstatus', 'message' => 'Specified TDEStatus is not configured on the This custins.', 'http_code' => 400, 'description' => 'The specified TDE state is not configured on this instance.'],
['code' => 'InvalidTDEstatus.Format', 'message' => 'The Specified TDEStatus is not valid.', 'http_code' => 400, 'description' => 'The status of TDE is invalid.'],
['code' => 'InvalidTDEStatus.NotFound', 'message' => 'The specified TDEStatus does not exist.', 'http_code' => 400, 'description' => 'The specified TDE status does not exist.'],
['code' => 'InvalidTempInstance.NotSupport', 'message' => 'The temp db Instance is not support.', 'http_code' => 403, 'description' => 'The instance is locked.'],
['code' => 'InvalidTempUpgradeRestoreTime', 'message' => 'The param TempUpgradeRestoreTime is invalid.', 'http_code' => 400, 'description' => 'The TempUpgradeRestoreTime parameter is invalid.'],
['code' => 'InvalidTerminationMode.NotFound', 'message' => 'The specified parameter TerminationMode does not exist.', 'http_code' => 404, 'description' => 'The specified parameter TerminationMode does not exist.'],
['code' => 'InvalidTime.Format', 'message' => 'Specified time is not valid.', 'http_code' => 400, 'description' => 'The time format is invalid.'],
['code' => 'InvalidTimeType.Malformed', 'message' => 'Specified TimeType is not valid.', 'http_code' => 400, 'description' => 'The time type is invalid.'],
['code' => 'InvalidTimeType.NotFound', 'message' => 'The parameter timeType does not exist.', 'http_code' => 404, 'description' => 'Check the TimeType parameter. Valid values: Year, Month, and Day.'],
['code' => 'InvalidTrafficMode.ModifyToStandardNotSupported', 'message' => 'The specified parameter NetworkInterfaceTrafficMode is not supported to modify to Standard.', 'http_code' => 400, 'description' => 'You cannot change the communication mode of an ENI to Standard.'],
['code' => 'InvalidTransType.NotSupport', 'message' => 'force local extend disk must in lockin.', 'http_code' => 400, 'description' => 'A lock condition is required to allow forced local expansion of the disk.'],
['code' => 'InvalidTransType.NotSupport', 'message' => 'When forcing local disk expansion, the instance must be in a locked state.', 'http_code' => 400, 'description' => 'To force a local disk to expand, the instance must be in the locked state.'],
['code' => 'InvalidTunnelId', 'message' => 'Specified conn tunnel is not valid.', 'http_code' => 400, 'description' => 'The specified connection tunnel is invalid.'],
['code' => 'InvalidUID.Duplicate', 'message' => 'Specified uid is not valid.', 'http_code' => 400, 'description' => 'Specified uid is not valid.'],
['code' => 'InvalidUID.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => 400, 'description' => 'The user account does not exist. Check whether the user account is correct.'],
['code' => 'InvalidUpgradeMode', 'message' => 'The Specified UpgradeMode is not valid.', 'http_code' => 400, 'description' => 'The specified upgrade mode is invalid.'],
['code' => 'InvalidUpgradeMode', 'message' => 'The Specified Parameter UpgradeMode is not valid.', 'http_code' => 500, 'description' => 'Parameter UpgradeMode value error'],
['code' => 'InvalidUpgradePrecheckResult', 'message' => 'The upgrade precheck failed. No successful precheck task found in the past 7 days', 'http_code' => 400, 'description' => 'The upgrade precheck failed. No successful precheck task is found within the last 7 days.'],
['code' => 'InvalidUsedTime', 'message' => 'The parameter usedTime is invalid.', 'http_code' => 400, 'description' => 'The specified usedTime parameter is invalid.'],
['code' => 'InvalidUsedTime', 'message' => 'The usedTime cannot be greater than the instance expiration time.', 'http_code' => 400, 'description' => 'The specified time cannot be greater than the expiration time of the instance.'],
['code' => 'InvalidUsedTime', 'message' => 'UsedTime can not Less than or equal to zero.', 'http_code' => 400, 'description' => 'The value of the UsedTime parameter must be greater than 0.'],
['code' => 'InvalidUsedTime', 'message' => 'The usedTime value should be between 1 and 11.', 'http_code' => 400, 'description' => 'The usedTime value should be between 1 and 11.'],
['code' => 'InvalidUsedTime.Format', 'message' => 'The specified parameter UsedTime is not valid.', 'http_code' => 400, 'description' => 'UsedTime is not defined.'],
['code' => 'InvalidUser.NotFound', 'message' => 'The specified user does not exist.', 'http_code' => 400, 'description' => 'The user cannot be found. Check the user information.'],
['code' => 'InvalidUser.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => 404, 'description' => 'The specified user is not found. Please check again.'],
['code' => 'InvalidUserAccount.NotSupported', 'message' => 'the Specified user account Validated not supported.', 'http_code' => 400, 'description' => 'the Specified user account Validated not supported.'],
['code' => 'InvalidUserBakset', 'message' => 'The user backup set to be imported is invalid.', 'http_code' => 400, 'description' => 'Imported user backup is invalid'],
['code' => 'InvalidUserData.Base64FormatInvalid', 'message' => 'The specified UserData is not valid.', 'http_code' => 400, 'description' => 'instance creation supports incoming userdata,base64 handles userdata exceptions'],
['code' => 'InvalidUserData.Base64FormatInvalid', 'message' => 'The specified UserData is not base64 encoded.', 'http_code' => 400, 'description' => 'The specified UserData is not base64 encoded'],
['code' => 'InvalidUserData.NotSupported', 'message' => 'The specified GPU instanceType is not supported the use of userdata.', 'http_code' => 400, 'description' => 'The specified GPU specification does not support the use of user-defined data'],
['code' => 'InvalidUserData.SizeExceed', 'message' => 'The UserData is invalid, the size of UserData should not greater than 32KB.', 'http_code' => 400, 'description' => 'UserData exceeds limit.'],
['code' => 'InvalidUserId.NotSupport', 'message' => 'The userid have no permission.', 'http_code' => 400, 'description' => 'The user does not have permissions.'],
['code' => 'InvalidUserId.NotSupport', 'message' => 'The user ID has no permission.', 'http_code' => 400, 'description' => 'The user identity does not have the required permissions.'],
['code' => 'InvalidUserOperatorPermission', 'message' => 'The user permission does not support this operation.', 'http_code' => 403, 'description' => 'The user is not authorized to perform this operation.'],
['code' => 'InvalidUserType.NotSupport', 'message' => 'The operation is not permitted due to type of account.', 'http_code' => 400, 'description' => 'The current account type does not support this operation.'],
['code' => 'InvalidUserType.NotSupported', 'message' => 'Your current account type does not support this operation.', 'http_code' => 403, 'description' => 'Your current account does not support this operation.'],
['code' => 'InvalidVersion', 'message' => 'current version not support operation.', 'http_code' => 400, 'description' => 'The current version does not support this operation.'],
['code' => 'InvalidVpc.Empty', 'message' => 'No VSwitch is created in the specified VPC. For more information, see the error message% s placeholder.', 'http_code' => 403, 'description' => 'No VSwitch is created in the specified VPC. For more information, see the error message% s placeholder.'],
['code' => 'InvalidVpc.Indeterminacy', 'message' => 'Invalid Vpc. Indeterminacy.', 'http_code' => 403, 'description' => 'Invalid Vpc. Uncertainty'],
['code' => 'InvalidVPCId', 'message' => 'The specified VPCId is invalid.', 'http_code' => 400, 'description' => 'The specified VPCId parameter is invalid.'],
['code' => 'InvalidVPCId.Mismatch', 'message' => 'Specified instance and security group are not in the same vpc.', 'http_code' => 400, 'description' => 'instance and security group are not in the same vpc'],
['code' => 'InvalidVPCId.NotFound', 'message' => 'Specified VPC ID is not found.', 'http_code' => 403, 'description' => 'The IP address of the VPC cannot be found. Check the IP address of the VPC.'],
['code' => 'InvalidVPCId.NotFound', 'message' => 'Specified virtual vpc is not found.', 'http_code' => 400, 'description' => 'The VPC ID cannot be found. Check the VPC ID.'],
['code' => 'InvalidVpcId.NotSupported', 'message' => 'The Specified vpcId or vSwitchId not supported.', 'http_code' => 400, 'description' => 'The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check whether the VPC or the vSwitch belongs to the same zone as the RDS instance.'],
['code' => 'InvalidVpcId.NotSupported', 'message' => 'The specified vpcId or vSwitchId is not supported.', 'http_code' => 400, 'description' => 'The operation failed. Check that the VPC or the vSwitch resides in the same zone as the RDS instance.'],
['code' => 'InvalidVpcIdOrVswitchId.NotSupported', 'message' => 'The specified vpcId or vSwitchId is not supported.', 'http_code' => 400, 'description' => 'The VPC that is specified by the vpcId parameter or the vSwitch that is specified by the vSwitchId parameter is not supported. Check the values of these parameters.'],
['code' => 'InvalidVpcIdOrVswitchId.NotSupported', 'message' => 'The VpcId or VswitchId is invalid.', 'http_code' => 404, 'description' => 'The operation failed. The VPC ID is invalid. Check the VPC ID.'],
['code' => 'InvalidVpcIdRegion.NotSupported', 'message' => 'The specified region does not allow you to create a VPC instance.', 'http_code' => 400, 'description' => 'The operation failed. The current region does not support creating a VPC instance.'],
['code' => 'InvalidVpcInfo.NotFound', 'message' => 'Specified VPC info does not exist.', 'http_code' => 403, 'description' => 'The specified VPC does not exist.'],
['code' => 'InvalidVpcInstanceId', 'message' => 'The specified VPC instance ID is invalid.', 'http_code' => 400, 'description' => 'The operation failed. The current VPC-connected instance ID is invalid.'],
['code' => 'InvalidVpcInstanceId', 'message' => 'Specified vpc instance id is not valid.', 'http_code' => 400, 'description' => 'The specified VPC ID is invalid.'],
['code' => 'InvalidVpcParameter', 'message' => 'Specified VPCId VSwitchId or IPAddress or TunnelId is not valid.', 'http_code' => 400, 'description' => 'The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters.'],
['code' => 'InvalidVpcParameter', 'message' => 'Either VPC ID or vSwitch ID is incorrect. Please check again.', 'http_code' => 400, 'description' => 'The operation failed. Check the value of the VPCId parameter.'],
['code' => 'InvalidVSwitch.IllegalStatus', 'message' => 'The operation is not allowed in the current VSwitch state. Expecting state includes "Created", but current state is "%s".', 'http_code' => 400, 'description' => 'The current switch status does not support this operation.'],
['code' => 'InvalidVswitchId', 'message' => 'Specified conn vswitch id is not valid.', 'http_code' => 403, 'description' => 'The specified VSwitchId is in an incorrect format or is empty.'],
['code' => 'InvalidVSwitchId.Format', 'message' => 'The specified vswitch Id format is incorrect.', 'http_code' => 400, 'description' => 'The specified vSwitch ID is in an incorrect format.'],
['code' => 'InvalidVSwitchId.IpInvalid', 'message' => 'The specified private IP address is invalid.', 'http_code' => 403, 'description' => 'The specified private IP address is invalid.'],
['code' => 'InvalidVSwitchId.IpNotEnough', 'message' => 'The number of IP addresses in the specified switch is insufficient.', 'http_code' => 403, 'description' => 'The number of IP addresses in the specified switch is insufficient.'],
['code' => 'InvalidVSwitchId.IpPrefixNotEnough', 'message' => 'The specified VSwitch does not have enough IP prefixes.', 'http_code' => 403, 'description' => 'The specified VSwitch does not have enough IP prefixes.'],
['code' => 'InvalidVSwitchId.Mismatch', 'message' => 'Specified instance and virtual switch are not in the same zone.', 'http_code' => 400, 'description' => 'The RDS instance and the vSwitch are not in the same zone.'],
['code' => 'InvalidVSwitchId.Mismatch', 'message' => 'Specified instance and vSwitch are not in the same zone.', 'http_code' => 400, 'description' => 'The operation failed. The zone of the RDS instance differs from the zone of the vSwitch. Make sure that the RDS instance and the vSwitch are in the same zone.'],
['code' => 'InvalidVSwitchId.NotFound', 'message' => 'The vSwitch is not found in the specified VPC.', 'http_code' => 404, 'description' => 'The vSwitch cannot be found in the VPC.'],
['code' => 'InvalidVSwitchId.NotFound', 'message' => 'Specified virtual switch is not found in specified VPC.', 'http_code' => 400, 'description' => 'No vSwitch is available in the VPC.'],
['code' => 'InvalidVSwitchId.NotFound', 'message' => 'The specified vSwitch is invalid.', 'http_code' => 404, 'description' => 'The operation failed. The vSwitch ID is invalid. Check the vSwitch ID.'],
['code' => 'InvalidVSwitchId.NotFound', 'message' => 'Specified vSwitch is not found in specified VPC.', 'http_code' => 400, 'description' => 'No vSwitch is found in the VPC.'],
['code' => 'InvalidVSwitchId.NotFound', 'message' => 'The specified VSwitchId is not found.', 'http_code' => 404, 'description' => 'The specified VSwitchId is not found.'],
['code' => 'InvalidVSwitchId.NotSupported', 'message' => 'The specified VSwitchId zone is not supported.', 'http_code' => 400, 'description' => 'The vSwitch ID is invalid. Check the vSwitch ID.'],
['code' => 'InvalidVSwitchId.NotSupported', 'message' => 'The specified VPC zone is not supported.', 'http_code' => 400, 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Migrate the RDS instance to a different zone and try again.'],
['code' => 'InvalidVSwitchIds', 'message' => 'Specified vSwitchId is invalid.', 'http_code' => 400, 'description' => 'The specified vSwitchId is invalid.'],
['code' => 'InvalidWeight.Format', 'message' => 'The Specified Weight format is not valid.', 'http_code' => 404, 'description' => 'The weight range is invalid.'],
['code' => 'InvalidWeight.NotFound', 'message' => 'The specified parameter Weight is not exist.', 'http_code' => 404, 'description' => 'The instance ID that maps the Weight parameter is not the ID of a read-only RDS instance that is attached to the primary RDS instance. Modify the instance ID and try again.'],
['code' => 'InvalidWhitelistNetType.Malformed', 'message' => 'The WhitelistNetworkType is invalid.', 'http_code' => 400, 'description' => 'The value of the WhitelistNetworkType parameter for the IP address whitelist is invalid. Check the value of this parameter.'],
['code' => 'InvalidWhitelistNetType.Malformed', 'message' => 'Specified WhitelistNetType is not valid.', 'http_code' => 400, 'description' => 'The specified WhitelistNetworkType is invalid. Please check again.'],
['code' => 'InvalidWhitelistTemplateId', 'message' => 'the template id list is invalid.', 'http_code' => 400, 'description' => 'The ID of the specified whitelist template is incorrect. Check the setting.'],
['code' => 'InvalidWhitelistTemplateName.Duplicated', 'message' => 'Whitelist template name duplicated.', 'http_code' => 400, 'description' => 'A duplicate whitelist template name already exists.'],
['code' => 'InvalidZone.NotSupported', 'message' => 'The Specified Zone not supported.', 'http_code' => 400, 'description' => 'The zone is invalid.'],
['code' => 'InvalidZone.NotSupportedForStorageType', 'message' => 'The specified zone is closed or invalid for Specified DBInstanceStorageType.', 'http_code' => 400, 'description' => 'The specified region is closed or invalid for the specified DBInstanceStorageType.'],
['code' => 'InvalidZoneId', 'message' => 'The specified zone does not exist in the node.', 'http_code' => 403, 'description' => 'The operation failed. The zone does not belong to the node zones of the instance. Select the correct zone.'],
['code' => 'InvalidZoneId.DiskCategoryUnsupported', 'message' => 'The specified disk category does not support setting the ZoneId.', 'http_code' => 400, 'description' => 'The specified disk type does not support setting the Availability Zone.'],
['code' => 'InvalidZoneId.NotEqual', 'message' => 'The parameter ZoneId is the same as the previous one', 'http_code' => 400, 'description' => 'The two zones are the same.'],
['code' => 'InvalidZoneId.NotFound', 'message' => 'The provided ZoneId does not exist.', 'http_code' => 404, 'description' => 'The zone cannot be found or is not open. Specify a different zone.'],
['code' => 'InvalidZoneId.NotNull', 'message' => 'The parameter ZoneId must not be null or auto', 'http_code' => 400, 'description' => 'ZoneId must not be null or auto.'],
['code' => 'InvalidZoneId.NotSupported', 'message' => 'The Specified vpc Zone not supported.', 'http_code' => 400, 'description' => 'VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.'],
['code' => 'InvalidZoneIdSlave1.Missing', 'message' => 'The parameter ZoneIdSlave1 must be specified.', 'http_code' => 400, 'description' => 'You must specify the secondary zone ID.'],
['code' => 'InvalidZoneIdSlave1.NotNull', 'message' => 'The parameter ZoneIdSlave1 must be specified.', 'http_code' => 400, 'description' => 'You must specify the ID of the secondary zone.'],
['code' => 'INVALID_SOURCE_INSTANCE.RDS_CUSTOM', 'message' => 'Source RdsCustom instance is not valid to import, please check instance attributes.', 'http_code' => 400, 'description' => 'The source RdsCustom instance cannot be used for RDS data import. Check the instance properties.'],
['code' => 'Invocation.ExceedQuota', 'message' => 'The invocation quota in the current region has been reached for today.', 'http_code' => 403, 'description' => 'The number of command executions in the current region has reached today\'s quota.'],
['code' => 'InvokeProxyFailure', 'message' => 'The request processing has failed due to service failure of rds api.', 'http_code' => 500, 'description' => 'The request failed to be processed due to an RDS API failure.'],
['code' => 'InvokeServiceFailed', 'message' => 'Invoke service failed, retry later.', 'http_code' => 400, 'description' => 'A request error occurred. Please try again later.'],
['code' => 'IO.Exception', 'message' => 'An IO exception occurred. Please try again later.', 'http_code' => 400, 'description' => 'A data transmission error occurred due to network issues. Please try again later.'],
['code' => 'IO.Exception', 'message' => 'IO exception, retry later.', 'http_code' => 400, 'description' => 'An I/O error occurred.'],
['code' => 'IOAccelerationEnabled', 'message' => 'Instances with IO acceleration enabled do not allow this operation.', 'http_code' => 400, 'description' => 'This operation is not allowed on instances with I/O acceleration enabled.'],
['code' => 'IO_ACCELERATION_NOT_ALLOWED', 'message' => 'IO-acceleration cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'The I/O acceleration feature cannot be enabled when you create a blue-green deployment.'],
['code' => 'IO_BURSTING_NOT_ALLOWED', 'message' => 'IO-bursting cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'The I/O burst feature cannot be enabled when you create a blue-green deployment.'],
['code' => 'IpAddressLimitExceeded', 'message' => 'You have reached the limit on your Ip usage.', 'http_code' => 400, 'description' => 'The number of IP addresses and CIDR blocks in the IP address whitelist exceeds the upper limit. Each IP address whitelist can contain a maximum of 1,000 IP addresses and CIDR blocks. Modify the number and try again.'],
['code' => 'JoinedGroupLimitExceed', 'message' => 'The number of security groups that the specified resource can join has reached the limit. For more information, see the actual returned error message.', 'http_code' => 400, 'description' => 'The number of security groups that the specified resource can join has reached the limit. For more information, see the actual returned error message.'],
['code' => 'Kms.Unauthorized', 'message' => 'KMS has not been authorized.', 'http_code' => 400, 'description' => 'KMS is not authorized.'],
['code' => 'KmsApiError', 'message' => 'User secret key invalid.', 'http_code' => 400, 'description' => 'The user key is invalid.'],
['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 403, 'description' => 'Failed to process the request due to a lock timeout.'],
['code' => 'LogBackupNotEnabled', 'message' => 'Specified instance does not enabled logbackup', 'http_code' => 400, 'description' => 'Log backup is not enabled for the specified instance.'],
['code' => 'LvsInVpc.NotSupport', 'message' => 'The specified instance not support lvs conn type for vpc.', 'http_code' => 404, 'description' => 'The LVS conn type of the VPC is not supported by the instance.'],
['code' => 'LX.ARGUMENT.ILLEGAL', 'message' => 'There is no valid configuration for the current instance configuration change.', 'http_code' => 400, 'description' => 'The parameters that you specified for the specification change are invalid.'],
['code' => 'ManualHATime.Format', 'message' => 'The format of ManualHATime is yyyy-MM-dd T HH:mm:ss Z.', 'http_code' => 400, 'description' => 'The format of ManualHATime must be yyyy-MM-dd\'T\'HH:MM:ss\'Z\'.'],
['code' => 'ManualHATimeIsNull', 'message' => 'ManualHATime can not be null when the value of haConfig is Manual.', 'http_code' => 400, 'description' => 'ManualHATime cannot be empty when the value of haConfig is Manual.'],
['code' => 'MappingInstanceLevel.NotFound', 'message' => 'Can not find the mapping instance level.', 'http_code' => 400, 'description' => 'The mapping instance specification was not found.'],
['code' => 'MasterDBInstanceClassNotSupport', 'message' => 'You can not create the readonly instance with the master instance class does not support.', 'http_code' => 403, 'description' => 'The operation failed. The current primary instance class does not support creating read-only instances.'],
['code' => 'MasterDBInstanceState.NotSupport', 'message' => 'The Master instance state does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['code' => 'MasterInstanceNotExist', 'message' => 'master instance not exist.', 'http_code' => 400, 'description' => 'The primary instance data does not exist.'],
['code' => 'MaxEniCountExceeded', 'message' => 'The maximum number of elastic network interfaces that can be operated has been exceeded.', 'http_code' => 403, 'description' => 'The maximum number of ENIs that can be operated has been exceeded.'],
['code' => 'MaxEniPrivateIpsCountExceeded', 'message' => 'The number of secondary private IPs assigned to the specified ENI exceeds the limit. For more information, see the actual return result of the %s placeholder in the error message.', 'http_code' => 403, 'description' => 'The number of secondary private IPs assigned to the specified ENI exceeds the limit. For more information, see the actual return result of the %s placeholder in the error message.'],
['code' => 'Maxscale.NotFound', 'message' => 'The related maxscale instance is not found.', 'http_code' => 404, 'description' => 'The operation failed. No associated MaxScale instances can be found.'],
['code' => 'Maxscale.NotFound', 'message' => 'The relative maxscale instance is not found.', 'http_code' => 404, 'description' => 'No associated maxscale instance is found.'],
['code' => 'MaxscaleAlreadyExist', 'message' => 'The Maxscale is already existed.', 'http_code' => 400, 'description' => 'The specified Maxscale already exists.'],
['code' => 'MaxscaleDisabledSSLError', 'message' => 'Target connectString is not enabled SSL.', 'http_code' => 400, 'description' => 'Target connectString is not enabled SSL.'],
['code' => 'MaxscaleInstanceNotSupport', 'message' => 'Instances with maxscale instance do not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for instances with MaxScale.'],
['code' => 'MaxScaleInstanceNotSupport', 'message' => 'Instances with maxscale do not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported on instances with MaxScale'],
['code' => 'MaxscaleInternalError', 'message' => 'Database proxy status is CLASS_CHANGING.', 'http_code' => 400, 'description' => 'The specifications of the database proxy are being changed. Restart the RDS instance later.'],
['code' => 'MaxScaleLevel.NotSupport', 'message' => 'The current maxscale ins_num does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The specifications of the database proxy are low.'],
['code' => 'MaxscaleMinorVersionNotSupport', 'message' => 'The Maxscale version used by the instance is too low, please upgrade the Maxscale version first.', 'http_code' => 403, 'description' => 'The version of the database proxy used by the instance is too low. Upgrade the version of the database proxy first.'],
['code' => 'MaxscaleNotSupport', 'message' => 'The current custins does not support Maxscale. Please check the conditions for enabling Maxscale.', 'http_code' => 400, 'description' => 'The operation failed. The dedicated proxy feature is not enabled for the RDS instance. Enable and configure the dedicated proxy feature for the RDS instance.'],
['code' => 'MaxscaleNotSupport', 'message' => 'Maxscale not supported', 'http_code' => 400, 'description' => 'Dedicated proxy is not supported by the instance. Please check the configuration information about enabling dedicated proxy.'],
['code' => 'MaxscaleNotSupport', 'message' => 'Current custins can not support Maxscale.', 'http_code' => 400, 'description' => 'This operation is not supported for instances with maxscale.'],
['code' => 'MaxscaleServiceLinkedRole.NotFound', 'message' => 'Service linked role \'AliyunServiceRoleForRDSProxyOnEcs\' not found.', 'http_code' => 400, 'description' => 'The database proxy service linked role was not found, please check.'],
['code' => 'MetaDataRequestFailed', 'message' => 'Meta data request failed.', 'http_code' => 400, 'description' => 'Metadata query failed.'],
['code' => 'MGRMasterNodeRestart.Unsupported', 'message' => 'Specific primary node is not supported to restart in MGR instance.', 'http_code' => 400, 'description' => 'The MGR instance cannot specify a primary restart.'],
['code' => 'MigrateAlreadyExistsFault', 'message' => 'Duplicate migration is forbidden.', 'http_code' => 400, 'description' => 'The same data cannot be migrated twice.'],
['code' => 'MigrateAlreadyExistsFault', 'message' => 'The rds instance already has a given vpc migrate task.', 'http_code' => 400, 'description' => 'The RDS instance already contains a VPC migration task.'],
['code' => 'MigrateAlreadyReadWriteSplitExistsFault', 'message' => 'The rds instance already has a given vpc migrate task.', 'http_code' => 403, 'description' => 'A task of migrating data to the specified VPC already exists.'],
['code' => 'MigrateSlaveNotSupport', 'message' => 'Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.', 'http_code' => 403, 'description' => 'The status of the current instance does not support the migration of only the backup database. Forced migration will reduce the performance of accessing the database. Please perform an HA switch first.'],
['code' => 'MigrationTaskAlreadyExists', 'message' => 'The instance already has a migrating task.', 'http_code' => 403, 'description' => 'A migration task already exists.'],
['code' => 'MinorVersionAttr.NotFound', 'message' => 'Cannot find minor version attribute by given custins.', 'http_code' => 400, 'description' => 'No minor engine version information is available.'],
['code' => 'MinorVersionNotSupport', 'message' => 'The current database minor version does not support the operation.', 'http_code' => 400, 'description' => 'The current instance kernel iteration does not support this operation. You can upgrade the kernel iteration.'],
['code' => 'MinorVersionNotSupport.SSLEnabled', 'message' => 'Custins minor version does not support current action.', 'http_code' => 400, 'description' => 'Custins minor version does not support current action.'],
['code' => 'MirrorInsExists', 'message' => 'Specified DB instance mirror ins already existed.', 'http_code' => 400, 'description' => 'Specified DB instance mirror ins already existed.'],
['code' => 'MissBackupSetAndRestoreTime.NotFound', 'message' => 'Both BackupSet and RestoreTime are null.', 'http_code' => 400, 'description' => 'The operation failed. The BackupSet parameter and the RestoreTime parameter are left unspecified.'],
['code' => 'MissingAction', 'message' => 'The request is missing an action parameter.', 'http_code' => 400, 'description' => 'A server error occurred.'],
['code' => 'MissingActivityId', 'message' => 'ActivityId is mandatory for this action.', 'http_code' => 400, 'description' => 'ActivityId is mandatory for this action.'],
['code' => 'MissingBucket', 'message' => 'The specified parameter Bucket is not found.', 'http_code' => 400, 'description' => 'The OSS bucket cannot be found. Create an OSS bucket in the same region as the RDS instance. '],
['code' => 'MissingCategory', 'message' => 'The instance is missing a category parameter.', 'http_code' => 400, 'description' => 'The category parameter is missing for the instance.'],
['code' => 'MissingConnectionString', 'message' => 'The request is missing a ConnectionString parameter.', 'http_code' => 400, 'description' => 'You must specify ConnectionString.'],
['code' => 'MissingLocation', 'message' => 'The specified parameter Location is not found.', 'http_code' => 400, 'description' => 'The value of the BackupLocation parameter is invalid. Specify a valid value.'],
['code' => 'MissingObject', 'message' => 'The specified parameter Object is not found.', 'http_code' => 400, 'description' => 'The operation failed. The backup file cannot be found.'],
['code' => 'MissingParam.Frequency', 'message' => 'The frequency must be specified when you create a timed task.', 'http_code' => 400, 'description' => 'The frequency must be specified when creating a scheduled task.'],
['code' => 'MissingParam.InstanceId', 'message' => 'The parameter instanceId is missing or empty.', 'http_code' => 400, 'description' => 'Instance ID is empty.'],
['code' => 'MissingParameter', 'message' => 'The input parameters DBInstanceClass and DBInstanceStorage all blank or no change.', 'http_code' => 400, 'description' => 'Some parameters are missing. Specify all the required parameters and try again.'],
['code' => 'MissingParameter', 'message' => 'The input parameter "OwnerId" or "OwnerAccount" that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The operation failed. The value of the OwnerId parameter is invalid.'],
['code' => 'MissingParameter', 'message' => 'The parameter - Tags should not be null', 'http_code' => 400, 'description' => 'You must specify Tag.N.Key.'],
['code' => 'MissingParameter', 'message' => 'Missing parameter, please check if the parameters are complete.', 'http_code' => 400, 'description' => 'A required parameter is missing. Please ensure all necessary parameters are provided.'],
['code' => 'MissingParameter.DiskIdOrDiskIds', 'message' => 'Specified parameter DiskId or DiskIds is missing.', 'http_code' => 400, 'description' => 'The specified parameter DiskId or DiskIds is missing.'],
['code' => 'MissingParameter.MinorVersionTag', 'message' => 'You must specify the parameter MinorVersionTag.', 'http_code' => 400, 'description' => 'The minor engine version cannot be left unspecified.'],
['code' => 'MissingParameter.ResourceIds', 'message' => 'The parameter ResourceIds.N must not be null.', 'http_code' => 400, 'description' => 'The ResourceIds.N parameter cannot be empty.'],
['code' => 'MissingParameter.ResourceTagKey', 'message' => 'You must specify ResourceTag.N.Key.', 'http_code' => 400, 'description' => 'You must specify ResourceTag.N.Key.'],
['code' => 'MissingParameter.TagKey', 'message' => 'You must specify Tag.N.Key.', 'http_code' => 400, 'description' => 'Please specify a tag key.'],
['code' => 'MissingPortRange', 'message' => 'The request is missing a portRange parameter.', 'http_code' => 400, 'description' => 'The request is missing a portRange parameter.'],
['code' => 'MissingRWSplistParam', 'message' => 'Custins is missing rw split param.', 'http_code' => 400, 'description' => 'The instance is missing a read/write split parameter.'],
['code' => 'MissingUID', 'message' => 'The request is missing a uid parameter.', 'http_code' => 400, 'description' => 'The operation failed. The UID in the request is left unspecified.'],
['code' => 'MissingUserID', 'message' => 'The request is missing a user_id parameter.', 'http_code' => 400, 'description' => 'The user ID cannot be found.'],
['code' => 'MissParam', 'message' => 'Template is null.', 'http_code' => 400, 'description' => 'Get resource template is empty.'],
['code' => 'ModifyDBInstanceClass', 'message' => null, 'http_code' => null, 'description' => 'The RDS instance is being migrated to different zones.'],
['code' => 'ModifyDBInstanceClass', 'message' => 'Zone migration in progress.', 'http_code' => 400, 'description' => 'The RDS instance is being migrated to different zones.'],
['code' => 'MoneyLessThan100', 'message' => 'The Account Monet less Than 100.', 'http_code' => 403, 'description' => 'Your account balance is insufficient. Add funds to your account.'],
['code' => 'MssqlLicense.LockModeWrong', 'message' => 'License is available, but instance is not correctly locked.', 'http_code' => 400, 'description' => 'Your SQL Server license is valid, but the instance is not in locked mode.'],
['code' => 'MssqlLicense.NotAvailable', 'message' => 'The SQL Server product key is not available.', 'http_code' => 400, 'description' => 'The SQL Server license entered by the user is not valid.'],
['code' => 'MssqlLicense.NotStandard', 'message' => 'The input string license is not standard.', 'http_code' => 400, 'description' => 'The MSSQL license format is incorrect. Check the license and try again.'],
['code' => 'MssqlLicense.UnlockInsFails', 'message' => 'License is available, but instance unlock fails unexpectedly.', 'http_code' => 400, 'description' => 'The user entered the correct license, but the unlock instance failed.'],
['code' => 'MssqlLicense.VersionUnmatch', 'message' => 'The database version of the SQL Server product key you provided does not match your RDS Instance.', 'http_code' => 400, 'description' => 'The license version does not match the instance to be activated. Verify the license version and try again.'],
['code' => 'MssqlLicenseStatus.ExistsActive', 'message' => 'The current state has been activated.', 'http_code' => 400, 'description' => 'The instance status is already activated.'],
['code' => 'MultiNodeInstanceCoverRestoreUnsupported', 'message' => 'More than 3 node instance not support covering restore.', 'http_code' => 404, 'description' => 'Instances with over three nodes cannot use the overwrite mode for recovery.'],
['code' => 'NetProtocolIpv6NotSupport', 'message' => 'Current DB instance ip protocal ipv6 does not support this operation.', 'http_code' => 400, 'description' => 'The IPv6 protocol of the current DB instance does not support this operation.'],
['code' => 'NetTypeExists', 'message' => 'The specified public network type already exists.', 'http_code' => 403, 'description' => ' '],
['code' => 'NetTypeExists', 'message' => 'Specified net type already existed.', 'http_code' => 403, 'description' => ' '],
['code' => 'NetTypeExists', 'message' => 'Specified network type already exists.', 'http_code' => 403, 'description' => 'Failed to change the network type. The new network type is the type of network in which the RDS instance resides.'],
['code' => 'NetTypeExists', 'message' => 'The specified public network type existed', 'http_code' => 404, 'description' => 'The new network type is the type of network in which the RDS instance resides.'],
['code' => 'NetWork.NotFound', 'message' => 'NetWork.NotFound', 'http_code' => 400, 'description' => 'The network is unavailable.'],
['code' => 'NetworkConnectionCreating', 'message' => 'The existing network connection is already being created, please do not create it repeatedly.', 'http_code' => 400, 'description' => 'An existing network connection has already been created, please do not create it again.'],
['code' => 'NetworkOrSqlTimeoutError', 'message' => 'Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.', 'http_code' => 408, 'description' => 'The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts.'],
['code' => 'NoActiveBYOK', 'message' => 'This custins no active byok.', 'http_code' => 403, 'description' => 'The disk encryption feature has not been enabled for the instance.'],
['code' => 'NoAttributeToModify', 'message' => 'No attribute to be modified in this request.', 'http_code' => 400, 'description' => 'No properties were modified.'],
['code' => 'NoAvailableDisasterRestoreBakset', 'message' => 'No available disaster restore bakset.', 'http_code' => 400, 'description' => 'No available restore set is found.'],
['code' => 'NoAvailableLogBackup', 'message' => 'No available log backup.', 'http_code' => 400, 'description' => 'No available log backup is found.'],
['code' => 'noAvailablePaymentMethod', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'],
['code' => 'NoAvailablePaymentMethod', 'message' => 'No payment method is specified for account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'Account does not specify a payment method. We recommend that you add a payment method.'],
['code' => 'NoBackupSetRegion', 'message' => 'BackupSetRegion is absence.', 'http_code' => 400, 'description' => 'The backup region does not exist.'],
['code' => 'NoBaksetName', 'message' => 'BaksetName is absence.', 'http_code' => 400, 'description' => 'The backup set name does not exist.'],
['code' => 'noIdentification', 'message' => 'Main account uid not authenticated.', 'http_code' => 403, 'description' => 'The Alibaba Cloud account UID is not verified.'],
['code' => 'NoPermission.Operator', 'message' => 'The operator is not permission for this operate.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'NoPermission.Operator', 'message' => 'The user is not authorized to operate on the specified resource.', 'http_code' => 400, 'description' => 'You are not authorized to perform operations on the specified resources.'],
['code' => 'NoPermission.SystemTag', 'message' => 'You have no permission to use system tags.', 'http_code' => 400, 'description' => 'You have no permission to use the system tag.'],
['code' => 'NoSourceInstanceName', 'message' => 'No SourceDBInstanceName.', 'http_code' => 400, 'description' => 'The source instance name is not found.'],
['code' => 'NotFindAvailableVswitch', 'message' => 'Secondary zone, no available switch found under the current vpc.', 'http_code' => 400, 'description' => 'in the current vpc, no vswitch is available in the standby zone of the instance.'],
['code' => 'NotFound.ParamGroupId', 'message' => 'Current ParamGroupId not found.', 'http_code' => 400, 'description' => 'The parameter template does not exist.'],
['code' => 'NotHaveProxy', 'message' => 'The current instance does not have a proxy.', 'http_code' => 403, 'description' => 'No proxy exists for the current instance.'],
['code' => 'NotInFlowController', 'message' => 'Sorry,no permission.', 'http_code' => 403, 'description' => 'Sorry,no permission.'],
['code' => 'NotSupportedBackupMethod', 'message' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'http_code' => 403, 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['code' => 'NotSupportReduceDiskSize', 'message' => 'Not support reduce disk size.', 'http_code' => 400, 'description' => 'You cannot decrease the disk size.'],
['code' => 'NOT_ENOUGH_BLANCE', 'message' => 'Your balance is insufficient, please recharge.', 'http_code' => 400, 'description' => 'The balance of your Alibaba Cloud account is insufficient, top up or add funds to your Alibaba Cloud account.'],
['code' => 'NOT_ENOUGH_QUOTA', 'message' => 'Your instance has reached the maximum.', 'http_code' => 400, 'description' => 'The number of instances reaches the upper limit. You can create a maximum of 30 primary instances and 5 read-only instances. Release the instances that are no longer needed.'],
['code' => 'NOT_RUNNING', 'message' => 'The instance is not running.', 'http_code' => 400, 'description' => 'The RDS instance is not running.'],
['code' => 'NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.', 'http_code' => 400, 'description' => 'The maximum number of ResourceIds is exceeded. The maximum value is 50.'],
['code' => 'NumberExceed.ResourceTags', 'message' => 'The maximum number of ResourceTags is exceeded.', 'http_code' => 400, 'description' => 'The number of resource tags exceeds the maximum limit.'],
['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'http_code' => 400, 'description' => 'The number of tags exceeds 20.'],
['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded. The maximum value is 20.', 'http_code' => 400, 'description' => 'The maximum number of Tag is exceeded. The maximum value is 20.'],
['code' => 'NumberExceed.Tags', 'message' => 'Ensure the number of tag parameters is not greater than 20.', 'http_code' => 400, 'description' => 'The number of tag parameters exceeds the maximum limit.'],
['code' => 'NumberExceed.Tags', 'message' => 'The Tags parameter number is exceed.', 'http_code' => 400, 'description' => 'The number of tags exceeds the maximum limit.'],
['code' => 'OldPasswordWrong', 'message' => 'The input old password is wrong.', 'http_code' => 403, 'description' => 'The password is invalid. Specify a valid password.'],
['code' => 'Operation.Forbidden', 'message' => 'The operation is not permitted.', 'http_code' => 403, 'description' => 'This operation is not allowed.'],
['code' => 'OperationDenied', 'message' => 'The vpc service is error, please check params.', 'http_code' => 403, 'description' => 'The operation failed. A VPC error occurred. Check the settings of the request parameters.'],
['code' => 'OperationDenied', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => 'Insufficient resources. Contact on-duty engineers to increase the inventory.'],
['code' => 'OperationDenied', 'message' => 'VPC IP is in use, please check.', 'http_code' => 400, 'description' => 'The operation failed. The VPC IP address has been used.'],
['code' => 'OperationDenied', 'message' => 'VPC system error', 'http_code' => 403, 'description' => 'The available resources in the region are insufficient. Specify a different region and try again.'],
['code' => 'OperationDenied', 'message' => 'The requested instance is out of resources.', 'http_code' => 403, 'description' => 'Insufficient resources. Contact on-duty engineers to increase the inventory.'],
['code' => 'OperationDenied', 'message' => 'The specified request is out of resources.', 'http_code' => 403, 'description' => 'The specified request resource is insufficient.'],
['code' => 'OperationDenied', 'message' => 'The specified image contains the snapshot of the data disk,does not support this operation.', 'http_code' => 400, 'description' => 'The instance type does not support this operation.'],
['code' => 'OperationDenied', 'message' => 'The specified operation is denied as this instanceType is not supported.', 'http_code' => 404, 'description' => 'The specified operation is denied as this instance type is not supported.'],
['code' => 'OperationDenied.AccountMode', 'message' => 'The operation is not permitted due to account mode of instance.', 'http_code' => 403, 'description' => 'The operation failed. The account mode of the current instance does not support this operation.'],
['code' => 'OperationDenied.AccountModeUpgrading', 'message' => 'This operation is not supported in instance status account permission upgrade.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Upgrading Account state.'],
['code' => 'OperationDenied.AccountNoFound', 'message' => 'The specified ownerId or resourceOwnerId is not found.', 'http_code' => 403, 'description' => 'The owner ID cannot be found. Check the owner ID.'],
['code' => 'OperationDenied.AccountStatus', 'message' => 'The operation is not permitted due to status of account.', 'http_code' => 403, 'description' => 'An account error occurred. Check the status of the account.'],
['code' => 'OperationDenied.AccountType', 'message' => 'The operation is not permitted due to type of account.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for this account type.'],
['code' => 'OperationDenied.ApiForbidden', 'message' => 'operation not permitted.', 'http_code' => 403, 'description' => 'The operation is not allowed.'],
['code' => 'OperationDenied.ApiForbidden', 'message' => 'Operation is not permitted.', 'http_code' => 403, 'description' => 'The operation is not supported.'],
['code' => 'OperationDenied.ApiForbiddenForLogBackupFrequency', 'message' => 'When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.', 'http_code' => 403, 'description' => 'When the instance is in snapshot backup mode, the log backup frequency must not be Same as Data Backup.'],
['code' => 'OperationDenied.AutoPay', 'message' => 'The operation is not permitted due to autoPay no supported.', 'http_code' => 403, 'description' => 'The RDS instance does not support auto-renewal.'],
['code' => 'OperationDenied.AutoRenewNotSupport', 'message' => 'The specified parameter AutoRenew is not support.', 'http_code' => 403, 'description' => 'The operation failed. Only subscription RDS instances support auto-renewal.'],
['code' => 'OperationDenied.BackupJobExists', 'message' => 'The operation is not permitted due to backup job exist.', 'http_code' => 403, 'description' => 'Failed to create a backup. A backup task is in progress. If you want to create a backup, delete the ongoing backup task.'],
['code' => 'OperationDenied.BackupLogStatus', 'message' => 'The Current backup log enable status does not support this operation.', 'http_code' => 403, 'description' => 'The operation is not supported. Log backups are enabled.'],
['code' => 'OperationDenied.BackupMethod', 'message' => 'The operation is not permitted method of backup.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported by the backup method that is specified by the BackMode parameter. Check the value of this parameter.'],
['code' => 'OperationDenied.BackupMethod', 'message' => 'The operation is not permitted due to BackupMethod no supported.', 'http_code' => 403, 'description' => 'The backup method is not supported.'],
['code' => 'OperationDenied.BackupSetDeleteNotSupport', 'message' => 'The Specified backup does not support this operation.', 'http_code' => 403, 'description' => 'The current backup set cannot be deleted.'],
['code' => 'OperationDenied.BackupStatus', 'message' => 'The operation is not permitted due to status of instance backup.', 'http_code' => 403, 'description' => 'The operation is not supported for a data backup file that is generated from a failed backup. Backups can be performed only after you enable backups.'],
['code' => 'OperationDenied.BackupStatus', 'message' => 'The operation is not permitted due to status of instancebackup.', 'http_code' => 403, 'description' => 'The data backup file is unavailable. Please try again later.'],
['code' => 'OperationDenied.BidInvalid', 'message' => 'The operation is not permitted due to ownerId or resourceOwnerId.', 'http_code' => 403, 'description' => 'The operation failed. The account that is specified by the ownerId or resourceOwnerId parameter does not have the required permissions. Use the ownerId or resourceOwnerId parameter to specify an account that has the required permissions.'],
['code' => 'OperationDenied.BidOwnResource', 'message' => 'Bid user can not own resource.', 'http_code' => 403, 'description' => 'The operation failed. The current ownerId or resourceOwnerId permissions are insufficient. Use a higher-level permission ownerId or resourceOwnerId to perform the operation.'],
['code' => 'OperationDenied.ChildDBInstanceExists', 'message' => 'The specified instance had child instance.', 'http_code' => 403, 'description' => 'The specified instance has a child instance.'],
['code' => 'OperationDenied.ChildDBInstanceExists', 'message' => 'The specified instance existed child instance.', 'http_code' => 403, 'description' => 'The operation is not supported. The RDS instance has child instances.'],
['code' => 'OperationDenied.ClassChanging', 'message' => 'This operation is not supported in instance status escalation.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Upgrading/Downgrading state.'],
['code' => 'OperationDenied.ClassicNetworkNotSupported', 'message' => 'The operation is not permitted due to ClassicNetwork instance.', 'http_code' => 403, 'description' => 'The operation failed. Classic network instances do not support this operation.'],
['code' => 'OperationDenied.ClassicNetworkType', 'message' => 'The operation is not permitted due to status of instance.', 'http_code' => 403, 'description' => 'The Classic network type does not support the current operation.'],
['code' => 'OperationDenied.CloudInstanceIdDuplicated', 'message' => 'The CloudInstanceId duplicated.', 'http_code' => 403, 'description' => 'The operation failed. The object whose ID is the same as the value of the CloudInstanceId parameter has been created.'],
['code' => 'OperationDenied.CloudInstanceIdDuplicated', 'message' => 'The CloudInstanceId duplicated', 'http_code' => 403, 'description' => 'CloudInstanceId is duplicated.'],
['code' => 'OperationDenied.ClusterIsExisted', 'message' => 'The specified vCluster is existed.', 'http_code' => 400, 'description' => 'The specified cluster already exists. Do not create it again.'],
['code' => 'OperationDenied.ClusterNotAccess', 'message' => 'No availble cluster.', 'http_code' => 403, 'description' => 'The instance ID is invalid.'],
['code' => 'OperationDenied.ClusterNotSupport', 'message' => 'The instance cluster does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the RDS instance.'],
['code' => 'OperationDenied.Creating', 'message' => 'This operation is not supported in instance state creation.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Creating state.'],
['code' => 'OperationDenied.DBInstance', 'message' => 'The operation is not permitted due to type of the instance.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['code' => 'OperationDenied.DBInstance', 'message' => 'The operation is not permitted due to status of the instance.', 'http_code' => 403, 'description' => 'The instance status does not support the operation.'],
['code' => 'OperationDenied.DBInstanceConnType', 'message' => 'The current DB instance connection type does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the network connection type of the RDS instance.'],
['code' => 'OperationDenied.DBInstanceEngine', 'message' => 'The operation is not permitted due to engine of instance.', 'http_code' => 403, 'description' => 'The operation failed. The database engine version of the RDS instance is outdated. Specify a valid database engine version.'],
['code' => 'OperationDenied.DBInstanceId', 'message' => 'The operation is not permitted due to DBInstanceId and SourceDBInstanceId is same.', 'http_code' => 403, 'description' => 'The operation failed. The name of the source RDS instance is the same as the name of the destination RDS instance. Modify the name of the source RDS instance or destination RDS instance.'],
['code' => 'OperationDenied.DBInstanceMonitorPeriod', 'message' => 'Current DB instance does not support this monitor period.', 'http_code' => 403, 'description' => 'The specified monitoring period is not supported for the current instance.'],
['code' => 'OperationDenied.DBInstanceNetType', 'message' => 'The operation is not permitted due to network type of the instance.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'OperationDenied.DBInstanceNetType', 'message' => 'Operation is denied by the network type of current database instance.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the network type of the RDS instance.'],
['code' => 'OperationDenied.DBInstanceState', 'message' => 'The current DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'The RDS instance is not in a ready state.'],
['code' => 'OperationDenied.DBInstanceStatus', 'message' => 'The operation is not permitted due to instance status.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not running.'],
['code' => 'OperationDenied.DBInstanceStatus', 'message' => 'The instance status does not support the operation.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is not running. You can renew, clone, change the network type, or change the password of an account for the RDS instance only when the RDS instance is running.'],
['code' => 'OperationDenied.DBInstanceStatus', 'message' => 'Operation is denied by the current database instance status.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is not in a ready state.'],
['code' => 'OperationDenied.DBInstanceStatus', 'message' => 'The operation is not permitted due to status of instance.', 'http_code' => 403, 'description' => 'The instance status does not support the operation.'],
['code' => 'OperationDenied.DBInstanceStorageReduce', 'message' => 'The operation is not permitted due to reduce storage.', 'http_code' => 403, 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['code' => 'OperationDenied.DBInstanceStorageReduce', 'message' => 'The operation is not permitted due to reduce storage.', 'http_code' => 403, 'description' => 'The operation is not supported due to reduced storage space.'],
['code' => 'OperationDenied.DBInstanceSyncMode', 'message' => 'The operation is not permitted due to instance sync mode.', 'http_code' => 403, 'description' => 'The operation failed. The value of the SyncMode parameter is invalid. Check the value of this parameter.'],
['code' => 'OperationDenied.DBInstanceType', 'message' => 'The operation is not permitted due to type of instance.', 'http_code' => 403, 'description' => 'The operation failed. Read-only instances do not support cloning. Check the instance type.'],
['code' => 'OperationDenied.DBInstanceType', 'message' => 'The operation is not permitted due to type of the instance.', 'http_code' => 403, 'description' => 'The current instance type does not support this operation.'],
['code' => 'OperationDenied.DBInstanceUseType', 'message' => 'The specified dbinstance use type is not found.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'OperationDenied.DBInstanceUseTypeNotSupport', 'message' => 'The specified dbinstance use type is not found.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported for the database engine of the RDS instance.'],
['code' => 'OperationDenied.DBInstnceInRegion', 'message' => 'The operation is not permitted due to DBInstance in the region.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'OperationDenied.DBNameAndAccountPrivilegeCount', 'message' => 'The operation is not permitted due to count of database or account privilege.', 'http_code' => 403, 'description' => 'The operation failed. The number of databases differs from the number of permissions.'],
['code' => 'OperationDenied.DBStatus', 'message' => 'The operation is not permitted due to status of database.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not in a ready state. The RDS instance runs SQL Server, and the databases that are created on the RDS instance are in the read-only state.'."\n"
.'In this case, the operation is supported only when the RDS instance meets the following requirements: 1) The RDS instance is available. 2) No temporary backups are in progress on the RDS instance. 3) No tasks are run to migrate the data of the RDS instance. 4) No tasks are run to restore the data of the RDS instance from backup files. 5) The backup files of the RDS instance have been uploaded to OSS buckets and are valid.'],
['code' => 'OperationDenied.DBStatus', 'message' => 'The operation is not permitted due to status of the database.', 'http_code' => 403, 'description' => 'The current database status does not support this operation'],
['code' => 'OperationDenied.DBType', 'message' => 'The operation is not permitted due to type of the database.', 'http_code' => 403, 'description' => 'The operation is not supported for the database engine of the RDS instance.'],
['code' => 'OperationDenied.Deleting', 'message' => 'This operation is not supported in instance status deletion.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Deleting state.'],
['code' => 'OperationDenied.DeletionProtection', 'message' => 'The operation is not permitted when the instance enabled deletion protection.', 'http_code' => 400, 'description' => 'Instances cannot be deleted if deletion protection is enabled.'],
['code' => 'OperationDenied.DeletionProtection', 'message' => 'The operation is not permitted when the instance is deletion protection is enabled.', 'http_code' => 403, 'description' => 'This operation is not allowed if deletion protection is enabled.'],
['code' => 'OperationDenied.DesiredSizeExceeded', 'message' => 'Not allowed to operate more than 100 nodes at one time.', 'http_code' => 400, 'description' => 'A one-time operation of more than 100 nodes is not allowed.'],
['code' => 'OperationDenied.Destoryed', 'message' => 'The instance state has been destroyed. This operation is not supported.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Destroyed state.'],
['code' => 'OperationDenied.DiskCreatingSnapshot', 'message' => 'The operation is denied due to a snapshot of the specified disk is not completed yet.', 'http_code' => 403, 'description' => 'The specified cloud disk is creating a snapshot.'],
['code' => 'OperationDenied.DiskTypeViolation', 'message' => 'The specified disk is a system disk and cannot support the operation.', 'http_code' => 403, 'description' => 'The specified cloud disk is a system disk and cannot be uninstalled.'],
['code' => 'OperationDenied.EnabledSSLNotSupport', 'message' => 'The specified parameter "EnabledSSL" is not valid.', 'http_code' => 403, 'description' => 'The value of the EnabledSSL parameter is invalid.'],
['code' => 'OperationDenied.FlavorNotSupported', 'message' => 'The flavor does not support preemptible instances.', 'http_code' => 403, 'description' => 'The flavor does not support preemptible instances.'],
['code' => 'OperationDenied.GuardDBInstanceLower', 'message' => 'The operation is not permitted due to higher guard instance version.', 'http_code' => 403, 'description' => 'The operation is not supported. The disaster recovery RDS instance runs a later database engine version.'],
['code' => 'OperationDenied.HaStatus', 'message' => 'The operation is not permitted due to haStatus no supported.', 'http_code' => 403, 'description' => 'The status of high availability is invalid.'],
['code' => 'OperationDenied.ImportStaus', 'message' => 'The operation is not permitted due to status of import.', 'http_code' => 403, 'description' => 'The operation failed. The import task is not in a ready state.'],
['code' => 'OperationDenied.IncorrectDiskStatus', 'message' => 'The current disk status does not support this operation.', 'http_code' => 403, 'description' => 'The current disk does not support this operation. Make sure that the disk is in normal use.'],
['code' => 'OperationDenied.IncorrectMigrationStatus', 'message' => 'Migration status does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is being migrated.'],
['code' => 'OperationDenied.IncorrectTaskStatus', 'message' => 'The operation is not permitted due to status of import.', 'http_code' => 403, 'description' => 'The operation is not supported. Data is being imported. Please try again later.'],
['code' => 'OperationDenied.IncorrectTaskStatus', 'message' => 'The operation is not permitted due to status of the task.', 'http_code' => 403, 'description' => 'The operation failed because the task status is invalid.'],
['code' => 'OperationDenied.InsCloning', 'message' => 'This operation is not supported in instance clones.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Cloning state.'],
['code' => 'OperationDenied.InsMaintaining', 'message' => 'This operation is not supported in instance status maintenance.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Maintaining state.'],
['code' => 'OperationDenied.InstanceDiskLimitExceeded', 'message' => 'The amount of the disk on instance in question reach its limits.', 'http_code' => 403, 'description' => 'The specified instance has reached the maximum number of cloud disks that can be attached.'],
['code' => 'OperationDenied.InvalidCluster', 'message' => 'The operation is not allowed for the cluster, please check clusterId and createExtraParam.', 'http_code' => 403, 'description' => 'The cluster information passed in is incorrect. Check the parameters.'],
['code' => 'OperationDenied.InvalidClusterStatus', 'message' => 'The specified cluster status not support current operation.', 'http_code' => 400, 'description' => 'The specified cluster status not support current operation.'],
['code' => 'OperationDenied.InvalidNodeNumber', 'message' => 'There are nodes in the cluster. Delete the Custom container node in the cluster first.', 'http_code' => 400, 'description' => 'There are nodes in the cluster. Delete the Custom container node in the cluster first.'],
['code' => 'OperationDenied.InvalidStorageSize', 'message' => 'The storage size limit is exceeded.', 'http_code' => 400, 'description' => 'The disk usage exceeds the upper limit. Free or expand disk space.'],
['code' => 'OperationDenied.JobStatus', 'message' => 'Failed to disconnect the synchronization link, unable to switch to the primary instance.', 'http_code' => 400, 'description' => 'The operation is prohibited. The tasks of the RDS instance are not in a ready state. Please try again later.'],
['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to instance being locked.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is locked. Check whether the RDS instance has expired or its storage capacity is exhausted. If the RDS instance has expired, renew the RDS instance. If the storage capacity is exhausted, expand the storage capacity of the RDS instance.'],
['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted due to lock of instance.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is locked possibly because the RDS instance expires or the storage capacity is exhausted. If the RDS instance expires, immediately renew the RDS instance. If the storage capacity is exhausted, contact your customer service representatives.'],
['code' => 'OperationDenied.LockMode', 'message' => 'The operation is not permitted when the instance locked.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is locked possibly because the balance within your Alibaba Cloud account is insufficient. Top up or add funds to your Alibaba Cloud account to unlock the RDS instance.'],
['code' => 'OperationDenied.MasterDBInstanceState', 'message' => 'The specified DB instance is not in the available state.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is not running.'],
['code' => 'OperationDenied.MasterDBInstanceState', 'message' => 'The operation is not permitted due to status of instance.', 'http_code' => 400, 'description' => 'The primary instance in the current instance status does not support this operation. Retry after the primary instance enters the Running state.'],
['code' => 'OperationDenied.MasterDBInstanceState', 'message' => 'The operation is not permitted due to status of master instance.', 'http_code' => 400, 'description' => 'The operation failed. The configuration of the read-only instance is being changed. In this case, you cannot perform this operation on the primary instance. Wait until the configuration of the read-only instance is changed and try again.'],
['code' => 'OperationDenied.MasterDBInstanceState', 'message' => 'The Primary instance in the current state does not support this operation. Try again when the Primary instance is in Running state.', 'http_code' => 400, 'description' => 'The primary instance in the current state does not support this operation. Try again when the primary instance is in Running state.'],
['code' => 'OperationDenied.MigrationStatus', 'message' => 'The operation is not permitted due to status of engine migration.', 'http_code' => 403, 'description' => 'The current migration state does not support this operation.'],
['code' => 'OperationDenied.MinorVersionTransing', 'message' => 'This operation is not supported in instance status minor version upgrade.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Updating Minor Version state.'],
['code' => 'OperationDenied.MinorVersionUpgrading', 'message' => 'This operation is not supported in instance minor version upgrade.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Updating Minor Version state.'],
['code' => 'OperationDenied.ModifyBackupSwitchOff', 'message' => 'The switch is not turned on. It is forbidden to modify the backup mode.', 'http_code' => 403, 'description' => 'Cross-region backup is not enabled.'],
['code' => 'OperationDenied.ModifyInternetBandwidth', 'message' => 'Specified instance has Eip Address, unassociate it first.', 'http_code' => 403, 'description' => 'The current instance is bound to an elastic public network and needs to be unbound first.'],
['code' => 'OperationDenied.MultiRegions', 'message' => 'Specified operation dose not support multiple regions.', 'http_code' => 400, 'description' => 'The current operation does not support multiple regions.'],
['code' => 'OperationDenied.NetCreating', 'message' => 'This operation is not supported in the instance state creation network connection.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Creating Network Connection state.'],
['code' => 'OperationDenied.NetDeleting', 'message' => 'This operation is not supported in the instance state release network connection.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Releasing Network Connection state.'],
['code' => 'OperationDenied.NetModifying', 'message' => 'This operation is not supported in the instance state modification network connection.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Modifying Network Connection state.'],
['code' => 'OperationDenied.NoDatabase', 'message' => 'The operation is not permitted due to no database.', 'http_code' => 403, 'description' => 'The database cannot be found. The database must be created before you back up the RDS instance.'],
['code' => 'OperationDenied.NodePoolNodes', 'message' => 'Please remove the nodes on the node pool before deleting.', 'http_code' => 400, 'description' => 'Remove the nodes from the node pool or shrink the node pool to 0 before deleting the node pool.'],
['code' => 'OperationDenied.NodePoolNotSupport', 'message' => 'There are no enough nodes in the running state without pods in the node pool. Please delete the pods from the nodes and try again, or choose specified nodes to be removed.', 'http_code' => 400, 'description' => 'There are not enough empty nodes in the running state in the node pool. Please delete the pod from the node and try again after ensuring that there are enough empty nodes in the running state in the node pool, or remove the specified node.'],
['code' => 'OperationDenied.NodePoolStateIsNotActive', 'message' => 'The state of the node pool is not active. If the state of the node pool is scaling failed, please align the desired size with the total nodes. After the node pool state changes to active, try again.', 'http_code' => 400, 'description' => 'The state of the node pool is not active. If the state of the node pool is scaling_failed, please align the desired size with the total nodes. After the node pool state changes to active, try again.'],
['code' => 'OperationDenied.NoEniStock', 'message' => 'The requested resource of ENI is insufficient in the specified ECS, please retry or upgrade to enterprise-level computing instance types.', 'http_code' => 400, 'description' => 'The ENI inventory resources on the current instance are insufficient. Try again or upgrade to enterprise-level specifications.'],
['code' => 'OperationDenied.NoPermission', 'message' => 'You are not authorized to do this action. You should be authorized by RAM.', 'http_code' => 400, 'description' => 'The account does not have the permissions. Use RAM to grant the permissions to the account and try again.'],
['code' => 'OperationDenied.NoPermission', 'message' => 'The user are not authorized to do this action. You should be authorized by product manager.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'OperationDenied.NoStock', 'message' => 'The requested resource is sold out in the specified zone, try other types of resources or other regions and zones.', 'http_code' => 403, 'description' => 'Inventory is insufficient.'],
['code' => 'OperationDenied.NotFoundBackup', 'message' => 'The operation is not permitted due to no backup.', 'http_code' => 403, 'description' => 'The backup set that you want to clone is not found. Specify an available backup set.'],
['code' => 'OperationDenied.NotFoundBackupSetIdOrRestoreTime', 'message' => 'The operation is not permitted due to no backupSetId or restoreTime.', 'http_code' => 400, 'description' => 'The operation is not supported. No data backup file ID or point in time is specified.'],
['code' => 'OperationDenied.NotFoundBackupSetIdOrRestoreTime', 'message' => 'The operation is not permitted due to no backupSetId or RrestoreTime.', 'http_code' => 403, 'description' => 'The operation is not supported. No data backup file ID or point in time is specified.'],
['code' => 'OperationDenied.NotSupport', 'message' => 'the specified instance region does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'OperationDenied.NotSupportedBackupMethod', 'message' => 'When the storage is larger than 4000 GB, only snapshot backup is supported.', 'http_code' => 403, 'description' => 'If the storage capacity is larger than 4,000 GB, only snapshot backup is supported.'],
['code' => 'OperationDenied.OperateFrequently', 'message' => 'The modification operation is too frequent.', 'http_code' => 400, 'description' => 'The modification operation is too frequent.'],
['code' => 'OperationDenied.OrderUnPaid', 'message' => 'The operation is not permitted due to the wrong Order status (Unpaid).', 'http_code' => 403, 'description' => 'The operation failed. You have unpaid orders. Check the unpaid orders in Account Center.'],
['code' => 'OperationDenied.OutofUsage', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => 'The available resources in the zone are insufficient. Specify a different zone.'],
['code' => 'OperationDenied.OwnerAccountNoFound', 'message' => 'The specified OwnerId or ResourceOwnerId does not exist.', 'http_code' => 403, 'description' => 'The current account is not found. Contact customer service with your request ID.'],
['code' => 'OperationDenied.PasswordWrong', 'message' => 'The operation is not permitted due to wrong of password.', 'http_code' => 403, 'description' => 'The password failed the verification check. Modify the password and try again.'],
['code' => 'OperationDenied.PayType', 'message' => 'Please wait for 15 minutes until the pay type is not PREPAY.', 'http_code' => 403, 'description' => 'The RDS instance is in the prepaid status. Try again in 15 minutes.'],
['code' => 'OperationDenied.PayType', 'message' => 'The operation is not permitted due to pay type of instance.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported for the billing method of the RDS instance.'],
['code' => 'OperationDenied.PerformanceLevelNotMatch', 'message' => 'The specified PerformanceLevel and disk size do not match.', 'http_code' => 403, 'description' => 'The specified performance level does not match the disk size.'],
['code' => 'OperationDenied.PrePayTypeNotSupported', 'message' => 'The operation is not permitted due to pay type of instance.', 'http_code' => 403, 'description' => 'Subscription instances cannot be directly deleted.'],
['code' => 'OperationDenied.PrimaryDBInstanceStatus', 'message' => 'The operation is not permitted due to status of primary instance.', 'http_code' => 403, 'description' => 'The operation failed. The RDS instance is deployed in a dedicated cluster and is not running.'],
['code' => 'OperationDenied.PrimaryDBInstanceType', 'message' => 'The operation is not permitted due to type of primary instance.', 'http_code' => 403, 'description' => 'The operation failed. Check whether the RDS instance is running. Read-only RDS instances cannot be cloned or backed up.'],
['code' => 'OperationDenied.Product', 'message' => 'The product code is not supported.', 'http_code' => 403, 'description' => 'The product code is not supported.'],
['code' => 'OperationDenied.PublicConnectionExists', 'message' => 'The specified public connection already existed.', 'http_code' => 403, 'description' => 'The public connection already exists.'],
['code' => 'OperationDenied.QuotaExceed', 'message' => 'The maximum number of Tags is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of Tags is exceeded.'],
['code' => 'OperationDenied.QuotaInsufficient', 'message' => 'The DAS Enterprise Edition (V1) quota is insufficient.', 'http_code' => 400, 'description' => 'The DAS Enterprise Edition (V1) quota is insufficient.'],
['code' => 'OperationDenied.ReadDBInstanceStatus', 'message' => 'The readOnly instance status does not support this operation.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance is not running.'],
['code' => 'OperationDenied.ReadinsMaintaining', 'message' => 'This operation is not supported in read-only instance maintenance.', 'http_code' => 400, 'description' => 'This operation is not supported when the read-only instance is in the maintaining state.'],
['code' => 'OperationDenied.ReadInsTransing', 'message' => 'This operation is not supported in read-only instance migration.', 'http_code' => 400, 'description' => 'This operation is not supported when the read-only instance is in the Migrating state.'],
['code' => 'OperationDenied.Region', 'message' => 'The operation is not permitted due to different region.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'OperationDenied.RegionIdNotSupported', 'message' => 'The region does not support preemptible instances.', 'http_code' => 403, 'description' => 'The region does not support preemptible instances.'],
['code' => 'OperationDenied.RequestExists', 'message' => 'The specified request already exists.', 'http_code' => 403, 'description' => 'The operation failed. The request has been created.'],
['code' => 'OperationDenied.RequestNotFinished', 'message' => 'The specified request not finished.', 'http_code' => 403, 'description' => 'The requested task is not completed.'],
['code' => 'OperationDenied.Resource', 'message' => 'Specified DB instance class or storage is not available in the specified Availability Zone.', 'http_code' => 403, 'description' => 'The resource is out of usage'],
['code' => 'OperationDenied.Resource', 'message' => 'The current instance type is insufficient. Select another instance type', 'http_code' => 400, 'description' => 'The instance type is unavailable. Specify a different instance type.'],
['code' => 'OperationDenied.Resource', 'message' => 'Specified DB instance class or storage is not available in all Availability Zones.', 'http_code' => 403, 'description' => 'Insufficient resources. Try again with a different instance type or storage size.'],
['code' => 'OperationDenied.Restarting', 'message' => 'This operation is not supported during instance state restart.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Restarting state.'],
['code' => 'OperationDenied.RestoreTime', 'message' => 'The instance with snapshot backup enabled can only be restored to the instance with snapshot backup enabled.', 'http_code' => 400, 'description' => 'You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup.'],
['code' => 'OperationDenied.RWSplitNetTypeExists', 'message' => 'OperationDenied.RWSplitNetTypeExists', 'http_code' => 400, 'description' => 'The operation failed. A read/write splitting endpoint is configured for the RDS instance. Release the read/write splitting endpoint and try again.'],
['code' => 'OperationDenied.SecurityIPListDuplicate', 'message' => 'The Specified same security IP already exists.', 'http_code' => 403, 'description' => 'The IP address already exists. Enter a new IP address.'],
['code' => 'OperationDenied.SlaveInsTransing', 'message' => 'This operation is not supported in instance backup library migration.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Migrating Secondary Instance state.'],
['code' => 'OperationDenied.SnapshotBackupSet', 'message' => 'Snapshot backup set can only be restored to the instance with snapshot backup enabled.', 'http_code' => 400, 'description' => 'You can only restore to snapshot backup-enabled instances for instances that have enabled snapshot backup and whose backup set type is snapshot.'],
['code' => 'OperationDenied.SnapshotNotAvailable', 'message' => 'The specified snapshot is not available.', 'http_code' => 403, 'description' => 'Snapshot not available'],
['code' => 'OperationDenied.SnapshotNotSupport', 'message' => 'The specified snapshot type is shared, which is not supported.', 'http_code' => 403, 'description' => 'Use of shared snapshots is not supported'],
['code' => 'OperationDenied.SQLLogActiveStatus', 'message' => 'The operation is not permitted due to SQLLogActive status.', 'http_code' => 403, 'description' => 'The value of the SQLLogActive parameter is invalid. Check the value of this parameter.'],
['code' => 'OperationDenied.SslModifying', 'message' => 'This operation is not supported in instance state SSL modification.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Modifying SSL state.'],
['code' => 'OperationDenied.Starting', 'message' => 'This operation is not supported during instance state startup.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Starting state.'],
['code' => 'OperationDenied.Stoped', 'message' => 'This operation is not supported in instance status downtime.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Stopping state.'],
['code' => 'OperationDenied.SubAccountNotAllowed', 'message' => 'Please check your account type, only the main account supports purchasing storage packages.', 'http_code' => 400, 'description' => 'Please check your account type, only the primary account supports purchasing storage packages.'],
['code' => 'OperationDenied.Switch', 'message' => 'Specified instance cannot be switched to VPC.', 'http_code' => 403, 'description' => 'The network type of the current instance cannot be changed to VPC because the instance is located in a VPC. Check the network type of the instance.'],
['code' => 'OperationDenied.Switch', 'message' => 'The specified instance must not be switched to VPC.', 'http_code' => 400, 'description' => 'The operation failed. The RDS instance cannot be switched to a VPC.'],
['code' => 'OperationDenied.Switch', 'message' => 'Specified instance can not be switched to VPC.', 'http_code' => 403, 'description' => 'The specified instance cannot be switched to VPC.'],
['code' => 'OperationDenied.SwitchSnapshotToPhysical', 'message' => 'Only physical backup to snapshot backup is supported.', 'http_code' => 403, 'description' => 'The current operation only supports physical backups to snapshot backups.'],
['code' => 'OperationDenied.SwitchToCrossRegionBackup', 'message' => 'Snapshot backup does not support cross region backup storage at present.', 'http_code' => 400, 'description' => 'Snapshot backups cannot be stored across regions.'],
['code' => 'OperationDenied.SwitchToSnapshot', 'message' => 'Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.', 'http_code' => 400, 'description' => 'Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode.'],
['code' => 'OperationDenied.SwitchToVPC', 'message' => 'Specified instance cannot be switched to VPC.', 'http_code' => 403, 'description' => 'The network type of the RDS instance cannot be changed to VPC.'],
['code' => 'OperationDenied.SystemConcurrent', 'message' => 'Failure caused by Concurrent operations.', 'http_code' => 403, 'description' => 'The concurrent operation failed. Try again later.'],
['code' => 'OperationDenied.TaskDuplicated', 'message' => 'The current task duplicated in the instance.', 'http_code' => 403, 'description' => ' '],
['code' => 'OperationDenied.TaskExceeded', 'message' => 'The concurrent tasks exceeded allowed amount.', 'http_code' => 403, 'description' => 'The number of concurrent tasks exceeds the maximum number of concurrent that are allowed. Modify the number of concurrent tasks and try again.'],
['code' => 'OperationDenied.TempDBInstanceExists', 'message' => 'The operation is not permitted due to temp instance exist.', 'http_code' => 403, 'description' => 'The operation failed. A temporary RDS instance has been created for the RDS instance.'],
['code' => 'OperationDenied.TimeLimit', 'message' => 'The interval between the two conversion operations must be greater than 15 minutes.', 'http_code' => 400, 'description' => 'The operation failed. The time interval between two operations that are performed to convert the payment type must be greater than 15 minutes.'],
['code' => 'OperationDenied.Timeout', 'message' => 'The request processing has failed due to timeout.', 'http_code' => 504, 'description' => 'Request failed due to timeout processing'],
['code' => 'OperationDenied.TimePeriod', 'message' => 'The specified parameter "TimePeriod" is not valid.', 'http_code' => 403, 'description' => 'The operation failed. The time period is invalid.'],
['code' => 'OperationDenied.TimestampNotSupported', 'message' => 'Preemptible instances are not for sale for current time.', 'http_code' => 403, 'description' => 'Preemptible instances are not for sale for the current time.'],
['code' => 'OperationDenied.Transing', 'message' => 'This operation is not supported in instance state migration.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Migrating state.'],
['code' => 'OperationDenied.UnSupportedNodePoolStatus', 'message' => 'Node pool status is not active please try again later.', 'http_code' => 400, 'description' => 'The current status of the node pool does not support this operation. Please try again later.'],
['code' => 'OperationDenied.VersionTransing', 'message' => 'This operation is not supported in the instance state migration version.', 'http_code' => 400, 'description' => 'This operation is not supported when the instance is in the Migrating Version state.'],
['code' => 'OperationDenied.VSwitchNotAccess', 'message' => 'No availble vSwitch.', 'http_code' => 403, 'description' => 'The vSwitch ID is invalid. Check the vSwitch ID.'],
['code' => 'OperationDenied.XengineSwitch', 'message' => 'Current custins can not turn off xengine param.', 'http_code' => 400, 'description' => 'The current instance has a xengine table and cannot switch to another parameter template.'],
['code' => 'OperationDenied.ZoneResource', 'message' => 'There is no available zone for inventory.', 'http_code' => 403, 'description' => 'There is no available zone for inventory.'],
['code' => 'OperationNotSupported', 'message' => 'This operation is not currently supported.', 'http_code' => 400, 'description' => 'This operation is not supported.'],
['code' => 'OperationUnsupported.MGR', 'message' => 'The sync mode mgr is not allowed to operate.', 'http_code' => 403, 'description' => 'This operation cannot be performed in the MySQL Group Replication replication mode.'],
['code' => 'OptimizedLockingOperateFailed', 'message' => 'Optimized Locking cannot be enabled for the database as Accelerated Database Recovery is not enabled for the database.', 'http_code' => 400, 'description' => 'Optimized locking cannot be enabled for the database because accelerated database recovery is not enabled for the database.'],
['code' => 'ORD.S.QUERY.PROD.ERROR', 'message' => 'An error occurred while querying the ordering information', 'http_code' => 400, 'description' => 'An order query error occurred.'],
['code' => 'Order.ComboInstanceNotAllowOperate', 'message' => 'A package instance is not allowed to operate independently.', 'http_code' => 400, 'description' => 'A package instance is not allowed to operate independently.'],
['code' => 'Order.InstHasUnpaidOrder', 'message' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.', 'http_code' => 400, 'description' => 'There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.'],
['code' => 'Order.InstHasUnsettledBills', 'message' => 'You currently have outstanding bills, please settle them first.', 'http_code' => 400, 'description' => 'You currently have outstanding bills, please settle them first.'],
['code' => 'Order.NoRealNameAuthentication', 'message' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.', 'http_code' => 400, 'description' => 'You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.'],
['code' => 'Order.PeriodInvalid', 'message' => 'There is a problem with the period you selected, please choose again.', 'http_code' => 400, 'description' => 'There is a problem with the period you selected, please choose again.'],
['code' => 'OrderCreatedFault', 'message' => 'You can not create the order due to the system reasons. please contact customer service.', 'http_code' => 400, 'description' => 'Failed to create the order due to system issues. Submit a ticket.'],
['code' => 'OrderQuotaExceeded', 'message' => 'Oops', 'http_code' => 400, 'description' => 'The operation failed. The maximum number of pay-as-you-go instances has been exceeded.'],
['code' => 'OrderQuotaExceeded', 'message' => 'Oops, unable to complete your payment. The reason for this error may be due to one of the following: 1. Your bank account funds are insufficient. 2. Your account is not yet verified. 3. You have already exceeded the maximum limit of RDS instances.', 'http_code' => 400, 'description' => 'The current payment could not be completed. The cause of this error may be one of the following reasons: 1. Your bank account has insufficient funds. Your account has not been verified. 3. You have exceeded the maximum limit of the RDS instance.'],
['code' => 'OrderQuotaExceeded', 'message' => 'Request would result in user exceeding the allowed amount of Postpaid instance across all DB instances.', 'http_code' => 400, 'description' => 'The maximum number of pay-as-you-go instances is exceeded.'],
['code' => 'OrderStatus.UnPaid', 'message' => 'The specified db instance has unpaid order.', 'http_code' => 403, 'description' => 'The instance has an unpaid order. Please pay first and try again.'],
['code' => 'OrderTaskAlreadyExists', 'message' => 'Order task already exists.', 'http_code' => 400, 'description' => 'The specified order task already exists.'],
['code' => 'OrdQueryAccountError', 'message' => 'Error calling account service.', 'http_code' => 400, 'description' => 'An error occurred while calling the account service.'],
['code' => 'OrdTCommodityQueryError', 'message' => 'Failed to query for product.', 'http_code' => 400, 'description' => 'Failed to query product.'],
['code' => 'OsAccountSameWithInstanceAccount', 'message' => 'The OS account name cannot be the same as the instance account name.', 'http_code' => 400, 'description' => 'The host account name cannot be the same as the instance user account name.'],
['code' => 'OtherEndpoint.Exist', 'message' => 'Other endpoint exist.', 'http_code' => 400, 'description' => 'The prefix of the connection address already exists'],
['code' => 'OtherEndpoint.Exist', 'message' => 'Other endpoint already exist.', 'http_code' => 400, 'description' => 'The endpoint already exists.'],
['code' => 'Param.Invalid', 'message' => 'Param invalid', 'http_code' => 400, 'description' => 'A request parameter error occurred.'],
['code' => 'Param.Invalid', 'message' => 'Param.Invalid', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
['code' => 'Param.Invalid.TimeEndBeforeStart', 'message' => 'Param invalid. End time before start time', 'http_code' => 400, 'description' => 'The end time cannot be earlier than the start time.'],
['code' => 'Param.NotFound', 'message' => 'The specified params is not found.', 'http_code' => 404, 'description' => 'The values of some parameters are invalid. Check the values of these parameters.'],
['code' => 'Param.NotFound', 'message' => 'Specified Param is not found.', 'http_code' => 404, 'description' => 'The specified parameter does not exist.'],
['code' => 'ParamError', 'message' => 'Invalid parameter', 'http_code' => 500, 'description' => 'The parameter is incorrect.'],
['code' => 'Parameter.Disabled', 'message' => 'Parameters should not be passed when CreateCommand.EnableParameter is false.', 'http_code' => 400, 'description' => 'Do not pass custom parameters when the command custom parameter feature is disabled.'],
['code' => 'Parameter.NotMatched', 'message' => 'The parameters of creation do not match those of invocation.', 'http_code' => 400, 'description' => 'The custom parameter passed in does not match the custom parameter defined when the command was created.'],
['code' => 'ParameterAbsence', 'message' => 'Necessary parameter is absence.', 'http_code' => 400, 'description' => 'You must pass in the required parameter.'],
['code' => 'ParameterCount.ExceedLimit', 'message' => 'The number of command parameters exceeds the maximum number that can be set.', 'http_code' => 403, 'description' => 'The number of custom parameters exceeds the limit.'],
['code' => 'ParameterIllegal', 'message' => 'Param is illegal parameter.', 'http_code' => 400, 'description' => 'The request parameter is invalid. Check the parameter.'],
['code' => 'ParameterKey.Duplicate', 'message' => 'The parameter may not contain duplicate keys.', 'http_code' => 400, 'description' => 'Parameter names cannot be duplicated. Please confirm and try again.'],
['code' => 'ParameterKey.ExceedLimit', 'message' => 'The length of the specified parameter key exceeds the maximum length that can be set.', 'http_code' => 403, 'description' => 'The length of the specified key exceeds the maximum length that can be set.'],
['code' => 'ParameterLeastAssociate', 'message' => 'Must input at least one optional parameter.', 'http_code' => 400, 'description' => 'The point in time or the data backup file cannot be left unspecified. Specify a point in time or a data backup file and try again.'],
['code' => 'ParameterLeastAssociate', 'message' => 'Must input at least one optional parameter', 'http_code' => 400, 'description' => 'You must enter at least one selectable parameter.'],
['code' => 'ParameterNotFound', 'message' => 'Parameter.taskType not found.', 'http_code' => 403, 'description' => 'Parameter taskType not found.'],
['code' => 'ParameterRequired', 'message' => 'parameter UnitNode. is required.', 'http_code' => 400, 'description' => 'You must specify the UnitNode parameter.'],
['code' => 'Parameters.Invalid', 'message' => 'Parameter error, please check the parameters.', 'http_code' => 400, 'description' => 'Parameter error, please check the parameters.'],
['code' => 'ParametersError', 'message' => 'Parameters is null.', 'http_code' => 400, 'description' => 'Parameter is empty'],
['code' => 'ParameterStore.InvalidParameters', 'message' => 'The parameter is invalid in Parameter Store.', 'http_code' => 403, 'description' => 'The parameter specified by {{oos :?}} in the command content was not found.'],
['code' => 'ParameterStore.NoPermission', 'message' => 'You have no access to Parameter Store.', 'http_code' => 403, 'description' => 'You do not have access to the parameter store.'],
['code' => 'ParameterStore.NotSupported', 'message' => 'Parameter Store is not supported in this region.', 'http_code' => 403, 'description' => 'Parameter storage is not supported in this area.'],
['code' => 'ParameterType.NotSupported', 'message' => 'The type of parameter value is not supported.', 'http_code' => 403, 'description' => 'The type of the custom parameter value is not supported.'],
['code' => 'PARAMETER_ERROR', 'message' => 'The parameter must not be null.', 'http_code' => 400, 'description' => 'Some parameters are empty. Specify these parameters.'],
['code' => 'PARAMETER_MUST_NOT_NULL', 'message' => 'The parameter must not be null.', 'http_code' => 400, 'description' => 'The parameter cannot be empty. Check the value of this parameter.'],
['code' => 'ParamGroupOptionKey.NotFound', 'message' => 'Specified system parameter group option unregistered.', 'http_code' => 404, 'description' => 'The specified system parameter group option is not registered.'],
['code' => 'ParamGroupOptionValue.NotFound', 'message' => 'Specified system parameter group option value not found.', 'http_code' => 404, 'description' => 'The specified system parameter template was not found.'],
['code' => 'ParamGroupOptionValue.NotSupport', 'message' => 'Specified option value unsupported.', 'http_code' => 400, 'description' => 'The specified option value is not supported.'],
['code' => 'ParamGroupsDbTypeError', 'message' => 'The instance does not match the specified parameter group.', 'http_code' => 400, 'description' => 'The parameter template is supported only for RDS instances that run MySQL 5.6, MySQL 5.7, or MySQL 8.0.'],
['code' => 'ParamGroupsDbTypeNotSupport', 'message' => 'The parameter group does not support the specified database type.', 'http_code' => 400, 'description' => 'The parameter template is supported only for RDS instances that run MySQL.'],
['code' => 'ParamGroupsDbVersionNotSupport', 'message' => 'The parameter group does not support the database version.', 'http_code' => 400, 'description' => 'The parameter template is supported only for RDS instances that run MySQL 5.6, MySQL 5.7, or MySQL 8.0.'],
['code' => 'ParamGroupsDescInvalid', 'message' => 'The maximum length of parameter group description is exceeded.', 'http_code' => 400, 'description' => 'The description of the parameter template can be up to 200 characters in length.'],
['code' => 'ParamGroupsInUse', 'message' => 'Delete an in-use param group is forbidden.', 'http_code' => 400, 'description' => 'A parameter template that is in use cannot be deleted.'],
['code' => 'ParamGroupsNameInvalid', 'message' => 'The specified parameter group name is invalid.', 'http_code' => 400, 'description' => 'The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter.'],
['code' => 'ParamGroupsNameInvalid', 'message' => 'The parameter group name is invalid.', 'http_code' => 400, 'description' => 'The name of the parameter template is invalid. The name must be 8 to 64 characters in length and can contain letters, digits, decimal points (.), and underscores (_). The name must start with a letter.'],
['code' => 'ParamGroupsNotExist', 'message' => 'The specified paramGroups does not exist.', 'http_code' => 400, 'description' => 'The parameter template cannot be found. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region.'],
['code' => 'ParamGroupsNotExistOrTypeNotSupport', 'message' => 'The parameter group does not exist or its type is not supported.', 'http_code' => 400, 'description' => 'The paramGroups does not exist or its type is not supported.'],
['code' => 'ParamGroupsNotExistOrTypeNotSupport', 'message' => 'The paramGroups does not exist or its type is not supported.', 'http_code' => 400, 'description' => 'The parameter template cannot be found or is not supported for the RDS instance. You can call the DescribeParameterGroups operation to query the parameter templates that are available to a specified region. Parameter templates are supported only for RDS instances that run MySQL.'],
['code' => 'ParamNotExist', 'message' => 'This param Not Exist', 'http_code' => 400, 'description' => 'The parameter does not exist. Check parameter configurations.'],
['code' => 'ParamNotFound', 'message' => 'The parameter is not found for the interface.', 'http_code' => 403, 'description' => 'The parameter is not found for the interface.'],
['code' => 'ParamTypeError', 'message' => 'The parameter type error.', 'http_code' => 400, 'description' => 'The parameter type is invalid.'],
['code' => 'pay.insufficientbalance', 'message' => 'Open volume paid cloud database. Your account balance is less than 100 RMB. Top-up and try again.', 'http_code' => 400, 'description' => 'The current balance is less than CNY 100. Please top up first and then make the purchase.'],
['code' => 'Pay.InsufficientBalance', 'message' => 'Insufficient available balance.', 'http_code' => 400, 'description' => 'Insufficient available balance.'],
['code' => 'pay.noCreditCard', 'message' => 'Account not bound to credit card.', 'http_code' => 400, 'description' => 'No credit card is available.'],
['code' => 'Pay.NoCreditCard', 'message' => 'No credit cards.', 'http_code' => 400, 'description' => 'No credit cards.'],
['code' => 'PayDeniedFault', 'message' => 'You can not complete the payment due to the pay system reasons. please contact customer service.', 'http_code' => 403, 'description' => 'Failed to complete the payment. Please try again later.'],
['code' => 'PAYFOR.CreditPayInsufficientBalance', 'message' => 'The Specified Account Has Insufficient Balance.', 'http_code' => 400, 'description' => 'Your account balance is insufficient. Check your account balance.'],
['code' => 'PDO_ASSOCIATED_NOT_ALLOWED', 'message' => 'PDO associated cannot exist when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'PDO associations cannot exist when creating a blue-green deployment.'],
['code' => 'PendingActionOverdue', 'message' => 'the action execution time is already overdue', 'http_code' => 400, 'description' => 'The specified execution time has expired.'],
['code' => 'PermissionDenied', 'message' => 'The current account has not been authorized to allow RDS to access user\'s KMS services, authorization needs to be granted to this account.', 'http_code' => 400, 'description' => 'The current account of the user does not authorize RDS to access the user\'s KMS service. KMS authorization is required. You can refer to the KMS document Authorizing RDS to Access Key Management Service for authorization.'],
['code' => 'PermissionDenied_CreateBlueGreenDeployment', 'message' => 'No permission to create blue green deployment.', 'http_code' => 400, 'description' => 'No permission to create blue-green deployment.'],
['code' => 'PgBouncerEnabled', 'message' => 'Instances with pgBouncer enabled do not allow this operation.', 'http_code' => 400, 'description' => 'This operation is not allowed on pgBouncer-enabled instances.'],
['code' => 'PhysicalCustins.NotFound', 'message' => 'Physical Custins Not Found.', 'http_code' => 404, 'description' => 'No physical customer can be found.'],
['code' => 'PostonlyOrTokenError', 'message' => 'PostonlyOrTokenError', 'http_code' => 400, 'description' => 'The session has expired, or a different account has logged on. Refresh the page and try again.'],
['code' => 'Postpaid.NotSupport', 'message' => 'The post pay payment method is not supported.', 'http_code' => 400, 'description' => 'The pay-as-you-go billing method is not supported. Check the billing method of the RDS instance.'],
['code' => 'Postpaid.NotSupport', 'message' => 'The charge type does not support for postpaid.', 'http_code' => 400, 'description' => 'Pay-as-you-go is not a supported billing type.'],
['code' => 'PreCheckInvalid', 'message' => 'CreateDdrInstance PreCheck Is Invalid', 'http_code' => 400, 'description' => 'The precheck for CreateDdrInstance is invalid.'],
['code' => 'Prepaid.NotSupport', 'message' => 'The charge type does not support for prepaid instance.', 'http_code' => 400, 'description' => 'The subscription instance does not support this payment type.'],
['code' => 'Price.CommoditySys', 'message' => 'Commodity system call exception.', 'http_code' => 400, 'description' => 'Commodity system call exception.'],
['code' => 'Price.HsfTimeoutError', 'message' => 'Inquiry error.', 'http_code' => 400, 'description' => 'A pricing inquiry error occurred.'],
['code' => 'Price.PricingPlanResultNotFound', 'message' => 'Pricing plan price result not found.', 'http_code' => 400, 'description' => 'Pricing plan price result not found.'],
['code' => 'Price.WanHuaTong.sys', 'message' => 'Inquiry error.', 'http_code' => 400, 'description' => 'A pricing inquiry error occurred.'],
['code' => 'PrimaryInstanceWithReadonlyNotSupport', 'message' => 'The specified primary instance with the read-only instance does not support the operation.', 'http_code' => 400, 'description' => 'This operation is not supported for the specified primary instance that has a read-only instance.'],
['code' => 'ProcuceLimited', 'message' => 'The Service User is limited to produce. please contact customer service.', 'http_code' => 403, 'description' => 'The account does not have the required permissions.'],
['code' => 'ProductInstanceReleased', 'message' => 'The instance has been released. Please check before placing the order.', 'http_code' => 400, 'description' => 'The instance has been released, please verify and place an order.'],
['code' => 'ProprietaryCloud.NotSupported', 'message' => 'The proprietary cloud not supported.', 'http_code' => 403, 'description' => 'This operation is not supported on Apsara Stack.'],
['code' => 'ProxyVersion.NotSupport', 'message' => 'The Proxy version is unsupported RwSplitNetType.', 'http_code' => 404, 'description' => 'Read/write splitting is not supported for the current instance.'],
['code' => 'PurchaseDurationInsufficient', 'message' => 'The purchase duration does not meet the requirements, please choose again.', 'http_code' => 400, 'description' => 'The purchase duration does not meet the requirements, please select again.'],
['code' => 'PurchaseRecord.Illegal', 'message' => 'Illegal purchase record.', 'http_code' => 403, 'description' => 'The parameter bizType or extend1 is invalid.'],
['code' => 'QuantityExceeded', 'message' => 'The number of order instances exceeds the limit.', 'http_code' => 400, 'description' => 'The number of purchased instances exceeds the limit.'],
['code' => 'QueryAccountInfo.Failed', 'message' => 'Failed query account information.', 'http_code' => 400, 'description' => 'Failed to query account information.'],
['code' => 'QueryPrice.Failed', 'message' => 'QueryPrice Failed.', 'http_code' => 404, 'description' => 'The inquiry failed. Contact Alibaba Cloud customer service representatives.'],
['code' => 'QueryPrice.UnfinishedOrder', 'message' => 'Unfinished order exists', 'http_code' => 400, 'description' => 'You have an overdue payment.'],
['code' => 'QueryPriceResonse.Failed', 'message' => 'query price response error.', 'http_code' => 400, 'description' => 'The operation failed. A network exception occurred in the current service, which caused the pricing inquiry to fail. Check the network to ensure it is functioning properly.'],
['code' => 'queryProdError', 'message' => 'Query subscription error: setProdListInSpecsData exception.', 'http_code' => 400, 'description' => 'A subscription query error occurred: setProdListInSpecsData exception.'],
['code' => 'QuotaExceed.DeploymentSetInstanceQuotaFull', 'message' => 'The instance quota in one deployment set exceeded.', 'http_code' => 403, 'description' => 'The number of instances in the current deployment set has reached the maximum.'],
['code' => 'QuotaExceed.ElasticQuota', 'message' => '%s.', 'http_code' => 400, 'description' => 'The ECS usage of the host corresponding to the Custom instance exceeds the quota limit, please go to the Aliyun official website console to apply for increasing the quota.'],
['code' => 'QuotaExceed.Snapshot', 'message' => 'The snapshot quota exceeds.', 'http_code' => 403, 'description' => 'The snapshot quota exceeds the limit. If you want to store new snapshots, delete the existing old snapshots without affecting your business.'],
['code' => 'QuotaExceed.Tags', 'message' => 'The number of tags exceeds the maximum number that can be configured.% s is a variable and will dynamically return error information based on the actual situation of the API call.', 'http_code' => 403, 'description' => 'The number of tags exceeds the maximum number that can be configured.% s is a variable and will dynamically return error information based on the actual situation of the API call.'],
['code' => 'QuotaExceeded.AccountName', 'message' => 'The quota of account exceeds.', 'http_code' => 400, 'description' => 'The number of accounts reaches the upper limit. The databases that are created on an RDS instance share all resources that are available on the RDS instance.'."\n"
.'If the RDS instance runs MySQL or SQL Server, up to 500 accounts can be created. '."\n"
.'If the RDS instance runs PostgreSQL or PPAS, the number of accounts is not limited. '."\n"
.'If the RDS instance runs MySQL 5.7 or SQL Server 2012, only a privileged account can be created.'],
['code' => 'QuotaExceeded.AccountName', 'message' => 'Account limit exceeded.', 'http_code' => 400, 'description' => 'The number of accounts reaches the upper limit. The databases that are created on an RDS instance share all resources that are available on the RDS instance. If the RDS instance runs MySQL or SQL Server, up to 500 accounts can be created. If the RDS instance runs PostgreSQL or PPAS, the number of accounts is not limited. If the RDS instance runs MySQL 5.7 or SQL Server 2012, only a privileged account can be created.'],
['code' => 'QuotaExceeded.BackupExtractFinished', 'message' => 'The Specified OAS backup set had extracted finish.', 'http_code' => 404, 'description' => 'The OAS backup set has already been extracted.'],
['code' => 'QuotaExceeded.CreateInstance', 'message' => 'The quota of create instance exceeds.', 'http_code' => 403, 'description' => 'The maximum number of instances has been exceeded. Release the instances that are no longer needed.'],
['code' => 'QuotaExceeded.DBInstanceStorage', 'message' => 'The quota of instance storage exceeds.', 'http_code' => 403, 'description' => 'The available storage space of the RDS instance is insufficient. Check the available storage space before you proceed.'],
['code' => 'QuotaExceeded.DBName', 'message' => 'The quota of db exceeds.', 'http_code' => 400, 'description' => 'The number of databases in the RDS instance reaches the upper limit. Modify the number of databases and try again.'],
['code' => 'QuotaExceeded.DBName', 'message' => 'The database operation execeed.', 'http_code' => 400, 'description' => 'The number of databases in the RDS instance reaches the upper limit. Modify the number of databases and try again.'],
['code' => 'QuotaExceeded.FileSize', 'message' => 'The quota of file size exceeds.', 'http_code' => 403, 'description' => 'The size of the file exceeds the upper limit. Modify the size of the file.'],
['code' => 'QuotaExceeded.OASExtractTimesExceeded', 'message' => 'The Current DB Instance backup set had extracted too many times from OAS today.', 'http_code' => 400, 'description' => 'The number of data backup files that are generated for the RDS instance on the day exceeds the maximum number of times that data can be extracted from the Office Automation System (OAS) per day.'],
['code' => 'QuotaExceeded.PrivateIpAddress', 'message' => 'There are not enough private IPs in the specified VSwitch.', 'http_code' => 400, 'description' => 'The current switch does not have enough Ip'],
['code' => 'QuotaExceeded.ReadonlyDBInstanceCount', 'message' => 'The quota of primary instance mounted read only instance.', 'http_code' => 403, 'description' => 'The quota takes effect only on the amount of data that is read from the primary RDS instance.'],
['code' => 'QuotaExceeded.StartDiagnose', 'message' => 'The quota of start diagnose exceeds now', 'http_code' => 403, 'description' => 'The number of diagnostic task requests reaches the upper limit. Please try again later.'],
['code' => 'QuotaExceeded.StartDiagnose', 'message' => 'The quota of start diagnose exceeds now,try again later.', 'http_code' => 400, 'description' => 'The quota is exceeded. Try again later.'],
['code' => 'QuotaExceeded.SwitchTime', 'message' => 'SwitchTimes limit exceeded.', 'http_code' => 400, 'description' => 'The number of switchovers between the internal and public endpoints on the day exceeds the maximum number of switchovers that are allowed per day.'],
['code' => 'QuotaExceeded.TagOnDBInstance', 'message' => 'The quota of tag on DBInstance exceeds.', 'http_code' => 404, 'description' => 'The number of tags on the database instance has exceeded the quota. Each instance can have a maximum of 20 tags.'],
['code' => 'QuotaExceeded.TagOnDBInstance', 'message' => 'The quota of tag on DBInstance exceeds.', 'http_code' => 404, 'description' => 'You cannot add more tags to the RDS instance. A maximum of 20 tags can be added to each RDS instance.'],
['code' => 'QuotaExceeded.Upload', 'message' => 'The quota of file exceeds.', 'http_code' => 403, 'description' => 'The number of files exceeds the maximum number of files that are allowed.'],
['code' => 'QuotaNotEnough', 'message' => 'Your current quota is insufficient. Please contact your channel partner to increase your quota.', 'http_code' => 400, 'description' => 'your current quota is insufficient. you can contact your channel partner to increase your quota.'],
['code' => 'RandomZoneNoVSwitch', 'message' => 'There is no vSwitch for the random zone. Please create a vSwitch in an available zone outside of the main available zone.', 'http_code' => 400, 'description' => 'No available vSwitch exists in the random zone. Create a vSwitch in a non-primary zone.'],
['code' => 'RDSBotServerError', 'message' => 'Insufficient sub account permissions.', 'http_code' => 400, 'description' => 'The sub-account has insufficient permissions.'],
['code' => 'RDSCategoryNotSupport', 'message' => 'The specified instance category does not support this operation.', 'http_code' => 403, 'description' => 'The operation failed. The current instance category does not support this operation.'],
['code' => 'ReadDBInstance.Mismatch', 'message' => 'The DB Instances has not matching for Weight.', 'http_code' => 404, 'description' => 'The read/write splitting weights are invalid. Configure the weights again.'],
['code' => 'ReadDBInstance.NotFound', 'message' => 'The current database instance does not contain any read only instance.', 'http_code' => 403, 'description' => 'The current database instance does not have a read-only instance.'],
['code' => 'ReadDBInstance.NotFound', 'message' => 'The Current DB Instance has not read-only instance.', 'http_code' => 400, 'description' => 'The database instance does not have any read-only instance.'],
['code' => 'ReadDBInstanceNotSupport', 'message' => 'The operation is not permitted due to type of the instance.', 'http_code' => 400, 'description' => 'Read-only instances are not allowed to perform this operation.'],
['code' => 'ReadEngineVersion.Malformed', 'message' => 'Current readins engine version does not support operations.', 'http_code' => 404, 'description' => 'The readins engine version does not support the operation.'],
['code' => 'Readins.NotFound', 'message' => 'The current instance does not contain any read only instance. The operation is not supported.', 'http_code' => 404, 'description' => 'The operation failed. The RDS instance is not attached with read-only RDS instances.'],
['code' => 'Readins.NotFound', 'message' => 'ReadOnly instance is not found.', 'http_code' => 400, 'description' => 'The read-only instance was not found.'],
['code' => 'ReadInstanceNotSupport', 'message' => 'Instances with read-only do not support this operation.', 'http_code' => 403, 'description' => 'Instances with read-only instances do not support this operation.'],
['code' => 'ReadonlyDBInstanceClassEmpty', 'message' => 'The read-only target instance class should not be empty.', 'http_code' => 400, 'description' => 'The target specification of the read-only instance must not be empty.'],
['code' => 'ReadonlyDBInstanceClassLowerThanMasterInstance', 'message' => 'The readonly instance db instance class are lower than master instance db instance class.', 'http_code' => 403, 'description' => 'The read-only instance has lower specifications than the primary instance.'],
['code' => 'ReadonlyDBInstanceClassNotSame', 'message' => 'All readonly db instances should have the same instance class.', 'http_code' => 400, 'description' => 'The current specifications of all read-only instances (including instance types and sizes) should be consistent.'],
['code' => 'ReadonlyDBInstanceClassNotSupport', 'message' => 'You can not create the readonly instance with the instance class does not support.', 'http_code' => 403, 'description' => 'The operation failed. The current instance class does not support creating read-only instances.'],
['code' => 'ReadonlyDBInstanceExceeded', 'message' => 'Current DB Instance exceeding the allowed amount of read instance.', 'http_code' => 404, 'description' => 'The number of database instance exceeds the valid range.'],
['code' => 'ReadonlyDBInstanceQuotaExceeded', 'message' => 'Request would result in user exceeding the allowed number of DB instances.', 'http_code' => 400, 'description' => 'The number of read-only instances reaches the quota. If the memory size of the primary instance is greater than or equal to 64 GB, up to 10 read-only instances can be created. If the memory size of the primary instance is less than 64 GB, up to five read-only instances can be created. If you need more than 10 read-only instances, contact Alibaba Cloud customer service or submit a ticket.'],
['code' => 'ReadonlyDBInstanceStorageExceeded', 'message' => 'You can not create the order with the db instance because The masterInstance storage value exceeding the readonlyInstance storage value.', 'http_code' => 403, 'description' => 'The primary instance storage value exceeds the read-only instance storage value. You cannot use the database instance to create an order.'],
['code' => 'ReadOnlyInsNotSupported', 'message' => 'Instances containing read-only instances do not allow this operation.', 'http_code' => 400, 'description' => 'This operation is not allowed for instances that contain read-only instances..'],
['code' => 'ReadOnlyInsNotSupported', 'message' => 'instances containing read-only instances do not allow this operation;', 'http_code' => 400, 'description' => 'This operation is not allowed on an instance that contains a read-only instance'],
['code' => 'ReadOnlyInstanceNotSupport', 'message' => 'Specified ReadOnly Instance not support this operation.', 'http_code' => 400, 'description' => 'Read-only instances do not support the operation.'],
['code' => 'ReadonlyInstanceNotSupport', 'message' => 'The operation is not permitted due to type of the instance.', 'http_code' => 400, 'description' => 'The specified read-only instance does not support this operation.'],
['code' => 'ReadOnlyInstanceNotSupport', 'message' => 'Read-only instance does not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for read-only instances.'],
['code' => 'ReadUniformNetTypeNotExists', 'message' => 'The specified uniform read only network type does not exist.', 'http_code' => 400, 'description' => 'The operation failed. The unified network type that you specify for the read-only RDS instances cannot be found.'],
['code' => 'ReadWriteSplitNetTypeExists', 'message' => 'The specified instance has ReadWriteSplitNetType enabled, disable ReadWriteSplitNetType before deleting the instance.', 'http_code' => 404, 'description' => 'Read/write splitting is enabled for the RDS instance. Before you release the RDS instance, disable read/write splitting.'],
['code' => 'ReadWriteSplitNetTypeExistx', 'message' => 'The specified instance has ReadWriteSplitNetType enabled, disable ReadWriteSplitNetType before deleting the instance.', 'http_code' => 404, 'description' => 'Read/write splitting is enabled for the RDS instance. Before you release a read-only instance of the RDS instance, you must disable read/write splitting for the RDS instance.'],
['code' => 'RealNameAuthenticationError', 'message' => 'Your account has not passed the real-name authentication yet.', 'http_code' => 403, 'description' => 'The operation failed. Complete real-name verification and try again.'],
['code' => 'RegionDissolvedEOM', 'message' => 'Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.', 'http_code' => 400, 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.'],
['code' => 'RegionDissolvedInduEOFS', 'message' => '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.', 'http_code' => 403, 'description' => 'Hello, Alibaba Cloud plans to optimize and adjust the region in India. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase, renewal, and configuration change orders. Thank you for your understanding and support.'],
['code' => 'RegionEndTimeDissolved', 'message' => 'The region was abolished and the service purchased was too long.', 'http_code' => 400, 'description' => 'The territory was abolished and the service purchased was too long.'],
['code' => 'RegionEndTimeDissolvedAustralia', 'message' => 'Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.', 'http_code' => 400, 'description' => 'Hello customer, this area has been abolished.'],
['code' => 'RegionEndTimeDissolvedIndia', 'message' => 'Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.', 'http_code' => 400, 'description' => 'Hello customer, this area has been abolished.'],
['code' => 'RegionEndTimeDissolvedIndia', 'message' => 'The region is no longer supported.', 'http_code' => 400, 'description' => 'The region is no longer supported.'],
['code' => 'RegionId.ApiNotSupported', 'message' => 'The api is not supported in this region.', 'http_code' => 400, 'description' => 'API calls are not supported in the specified region. Check whether the RegionId parameter values are correct.'],
['code' => 'RegionNotSupport', 'message' => 'The specified region is not supported.', 'http_code' => 403, 'description' => 'The operation failed. This operation is not supported in the specified region.'],
['code' => 'RegionNotSupport', 'message' => 'The region is not supported.', 'http_code' => 400, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'RegionUnauthorized', 'message' => 'There is no authority to create instance in the specified region.', 'http_code' => 403, 'description' => 'RDS instances cannot create in this region. Specify a different region and try again.'],
['code' => 'REGION_DISSOLVED_fuzhou_EOFS', 'message' => 'Alibaba Cloud is scheduled to make adjustments in the Fuzhou region. Cloud services in this region will be suspended. This type of order cannot be managed. Thank you for your understanding and support.', 'http_code' => 400, 'description' => 'Hello, customer, Alibaba Cloud plans to optimize and adjust the local cloud region in Fuzhou. Cloud services in this region will stop operating. You are currently unable to operate this type of order. Thank you for your understanding and support.'],
['code' => 'REGION_DISSOLVED_nanjing_EOFS', 'message' => 'Alibaba Cloud is scheduled to make adjustments in the Nanjing region. Cloud services in this region will be suspended. This type of order cannot be managed. Thank you for your understanding and support.', 'http_code' => 400, 'description' => 'Hello, customer, Alibaba Cloud plans to optimize and adjust the local cloud region in Nanjing. Cloud services in this region will stop operating. You are currently unable to operate this type of order. Thank you for your understanding and support.'],
['code' => 'RemainRefundOrderFail', 'message' => 'Reamin refund order for instance fail.', 'http_code' => 400, 'description' => 'Instance refund failed.'],
['code' => 'RenewChange.Exist', 'message' => 'The Current InstanceId existed renewChange order in RDS.', 'http_code' => 400, 'description' => 'A specification change task is in progress. Try again after the task is completed.'],
['code' => 'RenewChange.Exist', 'message' => 'The Current InstanceId exist renewChange order in RDS.', 'http_code' => 400, 'description' => 'An order was created to renew the instance or change specifications of the instance, but the order has not taken effect. Please try again later.'],
['code' => 'Reorder.failed', 'message' => 'Reorder failed.', 'http_code' => 400, 'description' => 'The conversion to subscription failed.'],
['code' => 'RepeatListParameter.TooManyRepeatListItems', 'message' => 'The Specified Parameter Tag Has Too Many Items.', 'http_code' => 400, 'description' => 'The Tag parameter contains too many key-value entries.'],
['code' => 'ReplaceSystemDisk.InvalidImageId', 'message' => 'The paid image only replace instance systemDisk using the original image.', 'http_code' => 400, 'description' => 'Paid mirroring can only be used to reinstall the original system.'],
['code' => 'ReplicaAlreadyExists', 'message' => 'The source DBInstanceId already bound to a replica.', 'http_code' => 400, 'description' => 'The operation failed. A backup has been created for the RDS instance.'],
['code' => 'Request.Forbidden', 'message' => 'Have no Permissions.', 'http_code' => 403, 'description' => 'The current operation is not authorized. Please contact the primary account to authorize the operation in the RAM console.'],
['code' => 'Request.NotFound', 'message' => 'The requested resource is not available.', 'http_code' => 404, 'description' => 'The requested resources are unavailable.'],
['code' => 'RequestFrequencyExceeded', 'message' => 'The order request is too much.', 'http_code' => 400, 'description' => 'The operation failed. Frequent order requests are initiated. Please try again later.'],
['code' => 'RequestFrequencyExceeded', 'message' => 'The order request is too much', 'http_code' => 400, 'description' => 'The system has received too many order requests.'],
['code' => 'RequestMetaDataFailed', 'message' => 'The service request failed. Please try again later or contact service personnel.', 'http_code' => 500, 'description' => 'The service request failed. Please try again later or contact service personnel.'],
['code' => 'RequestTimeout', 'message' => 'Query timed out.Please try again or narrow down the query scope.', 'http_code' => 408, 'description' => 'Request timed out, please try again or narrow the time range'],
['code' => 'RequiredParam.NotFound', 'message' => 'Required input param is not found.', 'http_code' => 400, 'description' => 'Required parameters are missing.'],
['code' => 'ResetAutoRenewalNotAllowed', 'message' => 'Reset auto renew not allowed.', 'http_code' => 400, 'description' => 'The user cannot reset automatic renewal.'],
['code' => 'ResetAutoRenewalNotAllowed.User', 'message' => 'Reset auto renew not allowed for current user.', 'http_code' => 400, 'description' => 'The user cannot reset automatic renewal.'],
['code' => 'ResourceConfigError', 'message' => 'The request processing has failed due to resource config error.', 'http_code' => 403, 'description' => 'The request failed due to a resource configuration error.'],
['code' => 'ResourceGroupId.InValid', 'message' => 'The Specified resource group id is not found.', 'http_code' => 400, 'description' => 'The resource group ID cannot be found. Check the resource group ID.'],
['code' => 'ResourcesNotInSameZone', 'message' => 'The specified instance and disk are not in the same zone.', 'http_code' => 403, 'description' => 'The specified instance and cloud disk are not in the same zone.'],
['code' => 'RestoreTableException', 'message' => 'RestoreTable Exception, result is null.', 'http_code' => 400, 'description' => 'A RestoreTable exception occurred. The result is null.'],
['code' => 'RestoreType.NotFound', 'message' => 'RestoreType is not found.', 'http_code' => 404, 'description' => 'RestoreType is not found.'],
['code' => 'Risk.controlRejection', 'message' => 'Risk control rejection.', 'http_code' => 403, 'description' => 'The operation failed. The Alibaba Cloud risk control system forbids the operation.'],
['code' => 'Risk.RiskControlRejection', 'message' => 'Your account is abnormal, please contact customer service for details.', 'http_code' => 400, 'description' => 'Your account is abnormal, please contact customer service for details.'],
['code' => 'RORDS', 'message' => 'You have reached the opening limit and can not open again.', 'http_code' => 400, 'description' => 'The number of instances exceeds the upper limit.'],
['code' => 'RR307', 'message' => 'A security risk is detected in your default payment method. Please verify your payment method before you can place orders. A verification link is sent to you by email and internal message.', 'http_code' => 403, 'description' => 'A security risk was detected in the default payment method. Please verify your payment method before placing your order. A verification link will be sent to you via email and internal message.'],
['code' => 'RR309', 'message' => '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.', 'http_code' => 400, 'description' => 'A security risk was detected in the default payment method. Please verify your payment method before placing your order. A verification link will be sent to you via email and internal message.'],
['code' => 'Rule.HsfTimeoutError', 'message' => 'Request rule service error.', 'http_code' => 400, 'description' => 'An error occurred when requesting the rule service.'],
['code' => 'RwSplitNetType.Exist', 'message' => 'The RwSplitNetType existed in the instance.', 'http_code' => 400, 'description' => 'This operation failed because read/write splitting is enabled for the instance. Before you release a read-only instance, disable read/write splitting.'],
['code' => 'SaleValidateFailed', 'message' => 'Commodity sales constraint verification failed.', 'http_code' => 400, 'description' => 'The sales constraint verification fails.'],
['code' => 'ScheduleTask.NotFound', 'message' => 'Parameter modification timed task not found.', 'http_code' => 400, 'description' => 'The scheduled task for parameter modification was not found.'],
['code' => 'ScheduleTask.OperationFailed', 'message' => 'Parameter modification timed task operation failed.', 'http_code' => 400, 'description' => 'The scheduled task for parameter modification failed.'],
['code' => 'SDK.InvalidRegionId', 'message' => 'Can not find endpoint to access.', 'http_code' => 400, 'description' => 'Cannot find endpoint to access.'],
['code' => 'SecondaryAddrNotSupportThisOperation', 'message' => 'The instance has a secondary instance address, so updates are not allowed.', 'http_code' => 400, 'description' => 'The instance contains the read-only address of the secondary node and cannot be upgraded.'],
['code' => 'SecondaryClassCode.Unsupported', 'message' => 'At least one secondary node has the same classCode as the primary node.', 'http_code' => 400, 'description' => 'At least one secondary node must have the same specifications as the primary node.'],
['code' => 'SecretNotFound', 'message' => 'Specified rds data api secret is not found', 'http_code' => 404, 'description' => 'The DataAPI credential is not found.'],
['code' => 'SecurityGroupInstanceLimitExceed', 'message' => 'The number of instances in the security group has reached the maximum limit.', 'http_code' => 403, 'description' => 'The number of instances in the security group has reached the maximum limit.'],
['code' => 'SecurityIPList.Format', 'message' => 'Specified SecurityIPList is not valid.', 'http_code' => 400, 'description' => 'The specified IP address whitelist is invalid.'],
['code' => 'SERVER.CLONE_INSTANCE_JOB_ERROR', 'message' => 'SERVER.CLONE_INSTANCE_JOB_ERROR', 'http_code' => 400, 'description' => 'The cloned instance failed the precheck. Please try again later.'],
['code' => 'SERVER.CREATE_BACKUP_JOB_ERROR', 'message' => 'SERVER.CREATE_BACKUP_JOB_ERROR', 'http_code' => 400, 'description' => 'The disaster recovery instance failed the verification and cannot be created. Check the configuration of the disaster recovery instance and try again.'],
['code' => 'SERVER.INSTANCE_ID_NOT_FOUND', 'message' => 'The server is out of service. Please try again later.', 'http_code' => 400, 'description' => 'An server error occurred. Please try again later.'],
['code' => 'SERVER.PRODUCT_TEMPLATE_NOT_FOUND', 'message' => 'The server is out of service. Please try again later.', 'http_code' => 400, 'description' => 'A server error occurred. Please try again later.'],
['code' => 'SERVER.WFE_ERROR', 'message' => 'SERVER.WFE_ERROR', 'http_code' => 400, 'description' => 'A server error occurred. Please try again later.'],
['code' => 'SERVER_ERROR_CODE', 'message' => 'The current request timed out, Please try again later.', 'http_code' => 400, 'description' => 'The operation failed. The request timed out because the requested service is unavailable. Please try again later.'],
['code' => 'ServiceLinkedRole.NotExist', 'message' => 'Service linked role for RDS PostgreSQL not exist.', 'http_code' => 400, 'description' => 'Create the AliyunServiceRoleForRdsPgsqlOnEcs role for ApsaraDB RDS for PostgreSQL.'],
['code' => 'ServiceLinkedRole.NotExist', 'message' => 'SLR is not authorized. Please check authorization in the service agreement to connect the network link of the RDS instance.', 'http_code' => 400, 'description' => 'The SLR authorization is not performed. To enable connections to your RDS instance, you must select SLR Authorization in the Terms of Service section.'],
['code' => 'ServiceLinkedRole.NotExist', 'message' => 'SLR does not exist, you needs to create SLR first.', 'http_code' => 400, 'description' => 'The SLR does not exist. You need to create an SLR first.'],
['code' => 'ServiceTemporarilyClosed', 'message' => 'Service temporarily closed.', 'http_code' => 400, 'description' => 'The task is closed.'],
['code' => 'ServiceUnavailable', 'message' => 'The server is not available. Try again later.', 'http_code' => 403, 'description' => 'A service error occurred.'],
['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 500, 'description' => 'The request has failed due to a temporary server failure. Please try again later.'],
['code' => 'ShareDBInstanceVPC.NotSupport', 'message' => 'The share instance not support vpc.', 'http_code' => 404, 'description' => 'Shared instances do not support VPC.'],
['code' => 'ShrinkCount.ReachedLimit', 'message' => 'Current DB shrink count reached the limit.', 'http_code' => 400, 'description' => 'The number of storage capacity reductions reaches the upper limit.'],
['code' => 'ShrinkCountReachedLimit', 'message' => 'Current DB shrink count reached the limit.', 'http_code' => 403, 'description' => 'The current database shrink count has reached the limit.'],
['code' => 'SignatureNonceUsed', 'message' => 'Specified signature nonce was used already.', 'http_code' => 403, 'description' => 'The specified signature nonce is in use.'],
['code' => 'SlaveClassCode.Unsupported', 'message' => 'Need at least one secondary\'s class_code same as primary\'s.', 'http_code' => 400, 'description' => 'At least one secondary node must have the same node specifications as the primary node.'],
['code' => 'SlaveZoneNotFound', 'message' => 'Slave zone does not exist.', 'http_code' => 400, 'description' => 'Missing slave zone'],
['code' => 'SourceAccountRoot.NotSupported', 'message' => 'Source DB contains account root.', 'http_code' => 400, 'description' => 'The source instance has an account named root'],
['code' => 'SourceRegionEqualsTargetRegionNotSupported', 'message' => 'The instance does not allowed to migrate when the target region equal the source region.', 'http_code' => 403, 'description' => 'The source region and the target region are the same. You cannot migrate the instance.'],
['code' => 'SourceRegionNotAllowedFault', 'message' => 'The source region does not allowed to migration.', 'http_code' => 403, 'description' => 'You cannot migrate the source region.'],
['code' => 'SqlExcutionFailed', 'message' => 'Failed to connect to host: connection timed out.', 'http_code' => 403, 'description' => 'The connection to the host timed out.'],
['code' => 'SqlExcutionFailed', 'message' => 'Database is in transition. Try the statement later.', 'http_code' => 400, 'description' => 'The database is being modified. Try again later.'],
['code' => 'SqlExcutionFailed', 'message' => 'Database is already open and can only have one user at a time.', 'http_code' => 400, 'description' => 'This database cannot be deleted.'],
['code' => 'SqlExcutionFailed', 'message' => 'Due to the limit number you can\'t create a database.', 'http_code' => 400, 'description' => 'This database cannot be deleted.'],
['code' => 'SqlExcutionFailed', 'message' => 'The database principal owns a database role and cannot be dropped.', 'http_code' => 400, 'description' => 'This database cannot be deleted.'],
['code' => 'SqlExecuteFailedOrTimeout', 'message' => 'sql command execution failed or timed out:%s.', 'http_code' => 400, 'description' => 'SQL command execution failed or timed out'],
['code' => 'SQLPermissionOperationFailed', 'message' => '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.', 'http_code' => 403, 'description' => 'Operation failed: SQL Server account permission operation is abnormal. Please check the following possible causes:-The specified user does not exist. -The user has object dependencies in the specified database, and cannot be rebuilt after the user is deleted. -Insufficient permissions to perform this authorized operation. -SQL Server is currently unavailable or unavailable.'],
['code' => 'SSLInstanceNotSupportThisOperation', 'message' => 'The instance opened SSL, upgrade is not this operation', 'http_code' => 400, 'description' => 'This operation is not supported for instances that have SSL enabled.'],
['code' => 'SSLNotSupport', 'message' => 'The CharacterType of instance does not support SSL.', 'http_code' => 400, 'description' => 'The character type of the instance does not support SSL.'],
['code' => 'SSL_NOT_ALLOWED', 'message' => 'SSL cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'The SSL feature cannot be enabled when creating a blue-green deployment.'],
['code' => 'StartTimeBeforeNow', 'message' => 'The start time should be later than current time.', 'http_code' => 400, 'description' => 'The start time must be later than the current time.'],
['code' => 'StatisticsUpdateNotSupported', 'message' => 'Updating statistics is not supported.', 'http_code' => 400, 'description' => 'Updating statistics is not supported.'],
['code' => 'StopService.Clone', 'message' => 'The service has been discontinued and cloning operations on classic network instances are no longer permitted.', 'http_code' => 400, 'description' => 'Because the classic network is offline and the service time has expired, you cannot clone an instance of the classic network type.'],
['code' => 'StopService.ModifyDBInstanceSpec', 'message' => 'The service has been discontinued and does not permit resizing operations on instances using the classic network.', 'http_code' => 400, 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot change the configuration of the instance.'],
['code' => 'StopService.Renew', 'message' => 'The service has been discontinued and renewal operations for instances on the classic network are no longer allowed.', 'http_code' => 400, 'description' => 'The classic network is offline. The current instance is of the classic network type and has exceeded the service stop time. You cannot renew the instance.'],
['code' => 'StorageEngine.NotSupported', 'message' => 'Current instance storage engine dose not support this operation.', 'http_code' => 400, 'description' => 'The storage engine of the current instance does not support this operation.'],
['code' => 'StorageLimitExceeded', 'message' => 'Exceeding the allowed Storage of DB instance.', 'http_code' => 404, 'description' => 'The disk usage exceeds the upper limit. Free your disk space.'],
['code' => 'StorageLimitExceeded', 'message' => 'Exceeding the allowed Storage of DB instance', 'http_code' => 403, 'description' => 'The disk space limit has been exceeded. Clear disk space.'],
['code' => 'StorageQuotaExceeded', 'message' => 'Request would result in user exceeding the allowed amount of storage available across all DB instances.', 'http_code' => 400, 'description' => 'The operation failed. The request has exceeded the available storage space for all database instances.'],
['code' => 'SwitchTimeAfterDeadline', 'message' => 'The switch time should be earlier than deadline.', 'http_code' => 400, 'description' => 'The switchover time is later than the latest allowed operation time.'],
['code' => 'SwitchTimeModeNotFound', 'message' => 'SwitchTimeMode should not be null when switchTime exists', 'http_code' => 404, 'description' => 'SwitchTimeMode must not be null when switchTime exists.'],
['code' => 'SwitchTimesLimitExceeded', 'message' => 'SwitchTimesQuotaExceeded: Exceeding the daily switch times of this DB instance.', 'http_code' => 400, 'description' => 'The number of network type changes has reached the daily upper limit. Try again the next day.'],
['code' => 'SYSTEM.CONCURRENT_OPERATE', 'message' => 'Concurrent operation is detected.', 'http_code' => 400, 'description' => 'Concurrent operations are run in the system.'],
['code' => 'System.Error', 'message' => 'The operation is error for current isntance.', 'http_code' => 403, 'description' => 'The operation failed.'],
['code' => 'SYSTEM.ILLEGALARGUMENT', 'message' => 'The current instance does not have a valid configuration when change the payType from Prepaid to Postpaid.', 'http_code' => 400, 'description' => 'No valid specification change configuration exists for the current instance.'],
['code' => 'system.illegalArgument', 'message' => 'There is no valid configuration change for the current instance。', 'http_code' => 400, 'description' => ''],
['code' => 'SYSTEM.SaleValidateFailed', 'message' => 'The request not refer to the correct order period. please check your Period or UsedTime param.', 'http_code' => 400, 'description' => 'A system error occurred during sales expression validation.'],
['code' => 'System.SaleValidateFailed', 'message' => 'Sales expression validation system error.', 'http_code' => 400, 'description' => 'A system error occurs when the sales expression is verified.'],
['code' => 'SystemError', 'message' => 'SystemError', 'http_code' => 400, 'description' => 'Failed to call the operation. Please try again later.'],
['code' => 'SystemError', 'message' => 'There are duplicate virtual commodity data.', 'http_code' => 400, 'description' => 'Duplicate commodity data of virtual network operators exists.'],
['code' => 'SystemParamGroupCode.Format', 'message' => 'Specific DBParamGroupId is not valid.', 'http_code' => 400, 'description' => 'The DBParamGroupId parameter for creation is invalid.'],
['code' => 'Tag.Allow5TagInfos', 'message' => 'only 5 tags allowed in one operation.', 'http_code' => 400, 'description' => 'The operation failed. You can specify up to five tags at a time.'],
['code' => 'Tag.InvalidTagsParameter', 'message' => 'tags parameter is invalid.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.InvalidTagsParamter', 'message' => 'tags parameter is invalid.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.Malformed', 'message' => 'The specified parameter Value is not valid.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.Malformed', 'message' => 'The specified parameter Value is not valid.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.Malformed', 'message' => 'The specified parameter Tag is not valid.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.Malformed', 'message' => 'The specified parameter Tag is not valid.', 'http_code' => 400, 'description' => 'The tag that is added to the RDS instance is invalid. Re-create a tag and add the tag to the RDS instance.'],
['code' => 'Tag.Mismatch', 'message' => 'Tag-Key and InvalidDBInstanceName.NotFoundag-Value is mismatch.', 'http_code' => 400, 'description' => 'The Tag Key does not match the instanceId.'],
['code' => 'Tag.NoDBInstanceIdExist', 'message' => 'You must specify the parameter DB instance ID.', 'http_code' => 400, 'description' => 'The instance ID cannot be left unspecified.'],
['code' => 'Tag.NoDBInstanceIdExist', 'message' => 'the dbinstance Id can not be blank.', 'http_code' => 400, 'description' => 'The database instance ID must not be empty.'],
['code' => 'Tag.NoRegionIdExist', 'message' => 'the region Id can not be blank.', 'http_code' => 400, 'description' => 'The RegionId parameter cannot be empty. Specify this parameter.'],
['code' => 'Tag.NoTagInfoExist', 'message' => 'all the tags and tagN parameters is null.', 'http_code' => 400, 'description' => 'The key and value of the tag are invalid. Specify a valid key and a valid value.'],
['code' => 'Tag.SetTagInfoAtTwoParameter', 'message' => 'only tags or tagN parameter could be setted.', 'http_code' => 400, 'description' => 'The settings of the tag are invalid.'],
['code' => 'Tag.SetTagInfoAtTwoParamters', 'message' => 'only tags or tagN parameter could be setted.', 'http_code' => 400, 'description' => 'The settings of the tag are invalid.'],
['code' => 'Tag.TagKeyCanNotBeAll', 'message' => 'tag key can not be all.', 'http_code' => 400, 'description' => 'The operation failed. Check the value of the TagKey parameter.'],
['code' => 'Tag.TagKeyDuplex', 'message' => 'tag key must be sole in one operation.', 'http_code' => 400, 'description' => 'The tag has been added to the RDS instance. Define a different tag.'],
['code' => 'Tag.TagKeyIsBlank', 'message' => 'tag key can not be blank.', 'http_code' => 400, 'description' => 'The tag is invalid. The key of the tag cannot be left unspecified.'],
['code' => 'Tag.TagKeyStartWith.aliyun', 'message' => 'tag key and value can not be started with aliyun.', 'http_code' => 400, 'description' => 'The tag is invalid. The key of the tag cannot start with aliyun.'],
['code' => 'Tag.TagKeyTooLong', 'message' => 'the max tag key s length is 64.', 'http_code' => 400, 'description' => 'The key of the tag exceeds 64 characters in length. Modify the key of the tag.'],
['code' => 'Tag.TagValueTooLong', 'message' => 'the max tag value is length is 128.', 'http_code' => 400, 'description' => 'The value of the tag exceeds the maximum length that is allowed. The maximum length is 128 characters. Modify the value of the tag.'],
['code' => 'Tag.TooManyDBInstanceIds', 'message' => 'The maximum number of instance ID is 30.', 'http_code' => 400, 'description' => 'The number of RDS instances reaches the upper limit. The upper limit is 30. Modify the number of RDS instances and try again.'],
['code' => 'Tag.TooManyDBInstanceIds', 'message' => 'the dbinstance Ids is more than 30.', 'http_code' => 400, 'description' => 'The number of database instance ID must not exceed 30.'],
['code' => 'Tag.TooManyTagsForOneInstance', 'message' => 'total 10 tags can be added to one resource.', 'http_code' => 400, 'description' => 'The number of tags exceeds the maximum number of tags that is allowed. The maximum number is 10.'],
['code' => 'TagKmsKeyError', 'message' => 'The KMS key is invalid.', 'http_code' => 400, 'description' => 'The key from KMS is incorrect.'],
['code' => 'TargetEngineVersion.Parameters.NotFound', 'message' => 'targetEngineVersion is missing in the request.', 'http_code' => 400, 'description' => 'The targetEngineVersion is missing in the request.'],
['code' => 'TargetInstanceEngineNotSupported', 'message' => 'The specified Engine cannot be supported the operation.', 'http_code' => 404, 'description' => 'The engine does not support the operation.'],
['code' => 'TargetInstanceForRegionIdUnsupported', 'message' => 'The instance regionId is not the same as the target instance regionId.', 'http_code' => 404, 'description' => 'The instance region ID and the target instance region ID are not the same.'],
['code' => 'TargetMajorVesionNotSupported', 'message' => 'The specified major version is not supported.', 'http_code' => 403, 'description' => 'Target large version not supported'],
['code' => 'TargetMajorVesionNotSupported', 'message' => 'The specified majorversion number is not supported.', 'http_code' => 403, 'description' => 'Major version not satisfied'],
['code' => 'TargetRegionNotAllowedFault', 'message' => 'The target region does not allowed to operate when the source instance is migrating to other region.', 'http_code' => 403, 'description' => 'When the source instance is being migrated to another region, you cannot modify the target region. '],
['code' => 'TargetStorageLessThanBottomLine', 'message' => 'The specified target storage value must be at least 20% larger than the currently used disk size.', 'http_code' => 400, 'description' => 'The operation failed. The storage capacity must be greater than or equal to 1.2 times the used storage space.'],
['code' => 'TargetStorageLessThanBottomLine', 'message' => 'The target storage is less than the baseline.', 'http_code' => 400, 'description' => 'The storage capacity cannot be less than the minimum storage capacity that is allowed.'],
['code' => 'TargetStorageLessThanBottomLine', 'message' => 'You cannot specify a target storage value less than the bottom line.', 'http_code' => 400, 'description' => 'The specified storage size cannot be less than the minimum value.'],
['code' => 'TaskExists', 'message' => 'Specified task have existed.', 'http_code' => 400, 'description' => 'The task already exists.'],
['code' => 'TaskHasExist', 'message' => 'The task already exists.', 'http_code' => 400, 'description' => 'The task already exists.'],
['code' => 'TaskHasStarted', 'message' => 'Task has started.', 'http_code' => 400, 'description' => 'The task has passed its start time.'],
['code' => 'TaskModifyError', 'message' => 'Part of the tasks cannot be modified.', 'http_code' => 400, 'description' => 'Some tasks cannot be modified.'],
['code' => 'TDEInstanceNotSupportThisOperation', 'message' => 'The instance opened TDE, this operation is not supported', 'http_code' => 400, 'description' => 'This operation is not supported for instances that have TDE enabled.'],
['code' => 'TDE_ENCRYPTION_NOT_ALLOWED', 'message' => 'TDE-encryption cannot be enabled when creating a blue-green deployment.', 'http_code' => 400, 'description' => 'When creating a blue-green deployment, TDE encryption cannot be enabled.'],
['code' => 'TemporaryAccessKey.Error', 'message' => 'The temporary accessKey is invalid.', 'http_code' => 403, 'description' => 'Temporary accessKey is invalid.'],
['code' => 'TempUpgrade.NotSupport', 'message' => 'The instance does not support temp upgrade.', 'http_code' => 400, 'description' => 'This instance does not support elastic upgrade.'],
['code' => 'Throttling', 'message' => 'There are no available resources in this zone.', 'http_code' => 400, 'description' => 'The traffic volume exceeds the quota. To increase the quota, submit a ticket.'],
['code' => 'Throttling', 'message' => 'Request was denied due to request throttling.', 'http_code' => 400, 'description' => 'The request is being streamed.'],
['code' => 'Throttling.User', 'message' => 'Request was denied due to user flow control.', 'http_code' => 403, 'description' => 'The request was denied due to throttling.'],
['code' => 'TimeoutRetryLater', 'message' => 'Timeout, please retry later', 'http_code' => 400, 'description' => 'The operation timed out. Please try again later.'],
['code' => 'TooManyDBs', 'message' => 'This instance has too many DBs.', 'http_code' => 403, 'description' => 'The instance has too many databases.'],
['code' => 'TooManyTables', 'message' => 'This instance has too many tables.', 'http_code' => 403, 'description' => 'This instance has too many tables.'],
['code' => 'TooManyWhitelistTemplateIds', 'message' => 'create dbinstance can support attach to up to 10 whitelist templates.', 'http_code' => 400, 'description' => 'Excessive number of incoming whitelist templates! You can associate up to 10 whitelist templates.'],
['code' => 'TradeNotSupportAsyncPay', 'message' => 'The Specified Trade Is Not Supported with Async Pay Type.', 'http_code' => 400, 'description' => 'The transaction does not support asynchronous payment.'],
['code' => 'TradeNotSupportAsyncPay', 'message' => 'The trade does not support asyncPay.', 'http_code' => 403, 'description' => 'Asynchronous payment is not supported.'],
['code' => 'TransformToPrePaidOrderExist', 'message' => 'The prepaid order task already exists.', 'http_code' => 403, 'description' => 'The subscription order task already exists.'],
['code' => 'Unavailable.Regions', 'message' => 'The available region does not exist.', 'http_code' => 404, 'description' => 'The available region does not exist.'],
['code' => 'UnexpectedBinlogConsumer', 'message' => 'Unexpected binlog consumer found.', 'http_code' => 400, 'description' => 'Unexpected binlog consumption. Switching is not allowed.'],
['code' => 'UnexpectedSwitchTime', 'message' => 'SwitchTime should not be null when switch at timePoint mode', 'http_code' => 403, 'description' => 'The switchover time cannot be left unspecified when you configure ApsaraDB RDS to perform a switchover at a specified point in time.'],
['code' => 'UnfinishedTerminateMigrateTask', 'message' => 'Specified MigrateTaskId terminate failed.', 'http_code' => 400, 'description' => 'Failed to stop the migration.'],
['code' => 'UnknowSwitchMode', 'message' => 'SwitchPromptly should be 0,1', 'http_code' => 403, 'description' => 'The value must be 0,1.'],
['code' => 'UnsettledBills', 'message' => 'The specified Instance has unsettled bills.', 'http_code' => 403, 'description' => 'You have overdue payments. Complete the payments.'],
['code' => 'UnSupportDbTypeReduceDiskSize', 'message' => 'The current instance does not support scale-in.', 'http_code' => 400, 'description' => 'The current instance does not support scale-in.'],
['code' => 'Unsupported.NodepoolNotSupported', 'message' => 'The operation is not supported for the current node pool.', 'http_code' => 400, 'description' => 'The current node pool does not support this operation.'],
['code' => 'UnsupportedArchitecture', 'message' => 'The architecture of classCode is not supported.', 'http_code' => 400, 'description' => 'The classcode schema is not supported.'],
['code' => 'UnsupportedByBlueGreenDeployment', 'message' => 'Operation prohibited due to blue green deployment.', 'http_code' => 403, 'description' => 'The operation is not allowed because a blue-green deployment exists.'],
['code' => 'UnsupportedClassCode', 'message' => 'The specified DB instance class stops selling.', 'http_code' => 400, 'description' => 'The specified DB instance class stops selling.'],
['code' => 'UnsupportedColdData', 'message' => 'Current coldDataEnabled parameter can not support.', 'http_code' => 400, 'description' => 'The specified region does not support cold storage.'],
['code' => 'UnsupportedCopyDbAlwaysOnToBasic', 'message' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Basic is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Cluster Edition to Basic Edition is not supported.'],
['code' => 'UnsupportedCopyDbAlwaysOnToHighAvailability', 'message' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:HighAvailability is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Cluster Edition to High-availability Edition is not supported.'],
['code' => 'UnsupportedCopyDbAlwaysOnToShare', 'message' => 'Replicate Database from RDS Category:AlwaysOn to RDS Category:Share is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Cluster Edition to Shared Edition is not supported.'],
['code' => 'UnsupportedCopyDbBasicToShare', 'message' => 'Replicate Database from RDS Category:Basic to RDS Category:Share is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Basic Edition to Shared Edition is not supported.'],
['code' => 'UnsupportedCopyDbHighAvailabilityToBasic', 'message' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Basic is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from High-availability Edition to Basic Edition is not supported.'],
['code' => 'UnsupportedCopyDbHighAvailabilityToShare', 'message' => 'Replicate Database from RDS Category:HighAvailability to RDS Category:Share is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from High-availability Edition to Shared Edition is not supported.'],
['code' => 'UnsupportedCopyDbShareToAlwaysOn', 'message' => 'Replicate Database from RDS Category:Share to RDS Category:AlwaysOn is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Shared Edition to Cluster Edition is not supported.'],
['code' => 'UnsupportedCopyDbShareToBasic', 'message' => 'Replicate Database from RDS Category:Share to RDS Category:Basic is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Shared Edition to Basic Edition is not supported.'],
['code' => 'UnsupportedCopyDbShareToHighAvailability', 'message' => 'Replicate Database from RDS Category:Share to RDS Category:HighAvailability is not supported.', 'http_code' => 403, 'description' => 'Replicating a database from Shared Edition to High-availability Edition is not supported.'],
['code' => 'UnsupportedDuckDBReadIns', 'message' => 'Physical custins with duckdb does not support to transfer to cloud disk.', 'http_code' => 400, 'description' => 'The primary local disk instance with a DuckDB read-only instance does not support upgrading to a cloud disk.'],
['code' => 'UnsupportedFtsIndex', 'message' => 'Current DB instance has fts index. Please delete in space fts index.', 'http_code' => 403, 'description' => 'The current instance contains full-text indexes created in the system tablespace. Delete and rebuild the corresponding full-text indexes before upgrading.'],
['code' => 'UnsupportedFtsIndexVersion', 'message' => 'Current DB instance has fts index. Please upgrade the minor version to a version after 20221130 and remove the space fts index.', 'http_code' => 403, 'description' => 'The current instance minor version is less than 20221130. Please upgrade the minor version before deleting or rebuilding the full-text index.'],
['code' => 'UnsupportedModifyDiskTypeWithOthers', 'message' => 'Disk type can\'t modify with disk size and class code.', 'http_code' => 400, 'description' => 'The disk type cannot be modified together with the disk size and specification.'],
['code' => 'UnsupportedModifyParam', 'message' => 'Burst param must be only modified.', 'http_code' => 400, 'description' => 'Burst param must be only modified.'],
['code' => 'UnsupportedNodepoolNotSupported', 'message' => 'Current node pool does not support this operation.', 'http_code' => 400, 'description' => 'The current node pool does not support the operation'],
['code' => 'UnsupportedNodepoolNotSupported', 'message' => 'The operation is not supported for the current node pool.', 'http_code' => 400, 'description' => 'The current node pool does not support this operation.'],
['code' => 'UnsupportedOperationDirection.DiskDowngrade', 'message' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: UPGRADE', 'http_code' => 400, 'description' => 'This operation is not allowed. Storage and instance type changes must be in the same direction. The current instance type change is an upgrade.'],
['code' => 'UnsupportedOperationDirection.DiskUpgrade', 'message' => 'The specified operation is not allowed, class and storage can only modify to one direction, current class: DOWNGRADE.', 'http_code' => 400, 'description' => 'This operation is not allowed. Storage and instance type changes must be in the same direction. The current instance type change is a downgrade.'],
['code' => 'UnsupportedParameter', 'message' => 'Unsupported parameter.', 'http_code' => 400, 'description' => 'The value of this parameter is invalid. Check the value of this parameter.'],
['code' => 'UnsupportedParameter', 'message' => 'The provided parameter is not supported.', 'http_code' => 400, 'description' => 'The provided parameter is not supported.'],
['code' => 'UnsupportedReadOrBakReadState', 'message' => 'Current DB instance has read or bak read running in unsupport states', 'http_code' => 403, 'description' => 'The current instance is in the unsupported read or bak read state.'],
['code' => 'UnsupportedReduceDiskSize', 'message' => 'Current Instance not support reduce disk size less than limit size.', 'http_code' => 400, 'description' => 'The current instance does not support reducing the disk size to less than the limit size.'],
['code' => 'UNSUPPORTED_INSTANCE_WITH_READ_INSTANCE', 'message' => 'Instance with read-only do not support this operation.', 'http_code' => 403, 'description' => 'This operation is not allowed because the instance contains read-only instances'],
['code' => 'UnsupportEncryptedSnapshot', 'message' => 'Encrypted DB instance snapshot does not support this operation.', 'http_code' => 400, 'description' => 'This operation is not supported for encrypted instance snapshots.'],
['code' => 'UnsupportExtendDisk.NotSupport', 'message' => 'Specified DB instance is unsupport extend disk.', 'http_code' => 400, 'description' => 'Disk expansion is not supported on the specified instance.'],
['code' => 'UnSupportNonXfsDiskSizeTooLarge', 'message' => 'Non xfs disk types do not support upgrading to 60T or above.', 'http_code' => 403, 'description' => 'Non-xfs disk types do not support upgrading to 60T or higher.'],
['code' => 'UnSupportReduceDiskSize', 'message' => 'Cloud disk instances do not support reduce disk size.', 'http_code' => 400, 'description' => 'You cannot reduce the storage capacity of an RDS instance that uses standard SSDs or ESSDs.'],
['code' => 'UnSupportReduceDiskSize', 'message' => 'Current instance type does not support reducing disk space.', 'http_code' => 403, 'description' => 'The value specified for disk size reduction is invalid.'],
['code' => 'UnSupportReduceDiskSize', 'message' => 'Target disk size is invalid to reduce.', 'http_code' => 400, 'description' => 'Invalid disk shrink value'],
['code' => 'Upgrade.NotSupport', 'message' => 'The input DB Instances class inconformity upgrade rules.', 'http_code' => 400, 'description' => 'The instance type passed in does not comply with the upgrade rule.'],
['code' => 'UpgradeEngineVersionCannotChangeStorage', 'message' => 'Upgrade engine version can not change storage size.', 'http_code' => 400, 'description' => 'Upgrading the engine version cannot also change the storage size.'],
['code' => 'UpgradeModeNotSupport', 'message' => '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.', 'http_code' => 400, 'description' => 'This upgrade method cannot be selected for local disk instances. For cloud disk instances, we recommend that you upgrade the minor version.'],
['code' => 'UpgradeSQLServerMinorVersionFail', 'message' => 'Upgrade Minor Version for SQLServer failed.', 'http_code' => 400, 'description' => 'Failed to update the minor version of SQL Server.'],
['code' => 'UpgradeVersionFoyMySQLUnsupported', 'message' => 'The specified instance can not upgrade to mysql 5.7 version.', 'http_code' => 404, 'description' => 'The specified instance cannot be upgraded to MySQL 5.7.'],
['code' => 'UploadLimitExceeded', 'message' => 'The limit on the daily upload times of this DB has been reached.', 'http_code' => 403, 'description' => 'The number of uploads on the day reaches the maximum number of uploads that are allowed per day.'],
['code' => 'UploadLimitExceeded', 'message' => 'UploadTimesQuotaExceeded: Exceeding the daily upload times of this DB.', 'http_code' => 403, 'description' => 'The operation failed. The number of data backup file downloads reaches the upper limit. Please try again later.'],
['code' => 'UserAlreadyExistInDb', 'message' => 'The current login already has a mapped user with the same name in the specific database. please try removing the existing user and retrying.', 'http_code' => 400, 'description' => 'The current login already has a mapped user with the same name in the specific database. Try deleting the existing user and try again.'],
['code' => 'UserBidForbiddenForJST', 'message' => null, 'http_code' => null, 'description' => 'CloudTmall users cannot purchase RDS instances in the ApsaraDB RDS console.'],
['code' => 'UserBidForbiddenForJST', 'message' => 'Jushita users do not support purchasing on the console.', 'http_code' => 400, 'description' => 'CloudTmall users cannot purchase RDS instances in the ApsaraDB RDS console.'],
['code' => 'UserDatabaseExceeded', 'message' => 'The specified instance can not contain user database.', 'http_code' => 404, 'description' => 'The instance must not contain user databases.'],
['code' => 'Username.ExceedLimit', 'message' => 'The length of the username exceeds the upper limit.', 'http_code' => 403, 'description' => 'The username length exceeds the limit.'],
['code' => 'UserNotInTheWhiteList', 'message' => 'The user is not in disk white list.', 'http_code' => 403, 'description' => 'You are not in the disk whitelist. Please add it to the whitelist and try again.'],
['code' => 'UserPermissionFailure', 'message' => 'The request processing has failed due to user permission.', 'http_code' => 400, 'description' => 'The user does not have sufficient permissions.'],
['code' => 'VisitAopApiError', 'message' => 'Visit active operation service api error.', 'http_code' => 400, 'description' => 'error accessing the active operation and maintenance service api.'],
['code' => 'VpcDoesNotCoverVSwitch', 'message' => 'The Vpc does not cover to the VSwitch.', 'http_code' => 400, 'description' => 'The VSwitch is not in the specified VPC.'],
['code' => 'VpcIzNoNotEqualsRdsMultIzNo', 'message' => 'Specified vpc IzNo not equal rds IzNo.', 'http_code' => 400, 'description' => 'The zone of the VPC is different from the zone of the RDS instance.'],
['code' => 'VpcIzNoNotEqualsRdsMultIzNo', 'message' => 'Specified VPC IzNo does not equal to RDS IzNo.', 'http_code' => 400, 'description' => 'The zone of the VPC differs from the zone of the RDS instance. Make sure that the VPC and the RDS instance reside in the same zone.'],
['code' => 'VpcNetworkTypeNotSupport', 'message' => 'The vpc network type instance does not support this operation.', 'http_code' => 400, 'description' => 'The vpc network type instance does not support this operation.'],
['code' => 'VswitchIpExhausted', 'message' => 'Vswitch IP exhausted.', 'http_code' => 400, 'description' => 'The operation failed. No vSwitch IP addresses are available.'],
['code' => 'VswitchIpExhausted', 'message' => 'No available ip in the specified vswitch.', 'http_code' => 400, 'description' => 'No available IP address exists in the specified vSwitch.'],
['code' => 'VSwitchIpNotEnough', 'message' => 'The vswitch requires at least two available IP addresses.', 'http_code' => 400, 'description' => 'The switch requires at least two available IP addresses.'],
['code' => 'WhitelistIPLength.Forbidden', 'message' => 'Whitelist ip length exceeeds the limit.', 'http_code' => 401, 'description' => 'The length of the IP whitelist exceeds the limit.'],
['code' => 'WhitelistIPType.Unsupported', 'message' => 'The specified SecurityIPType is not valid, only support ipv4.', 'http_code' => 400, 'description' => 'The whitelist IP address type SecurityIPType invalid, only IPv4 is supported.'],
['code' => 'WhitelistTemplateId.NotFound', 'message' => 'Whitelist Template id not found.', 'http_code' => 404, 'description' => 'The whitelist template ID was not found.'],
['code' => 'WhiteListTemplateIdNotFound', 'message' => 'Whitelist Template ID not found.', 'http_code' => 404, 'description' => 'The specified whitelist template ID does not exist.'],
['code' => 'WhitelistTemplateRelationToCustinsId.EXISTS', 'message' => 'Whitelist Template relation to CustinsId exists.', 'http_code' => 401, 'description' => 'The whitelist template is already associated with an instance.'],
['code' => 'WhitelistTemplateRelationToCustinsId.NotFound', 'message' => 'Whitelist Template relation to CustinsId not found.', 'http_code' => 404, 'description' => 'The association between the whitelist template and the instance was not found.'],
['code' => 'WindowsPasswordName.ExceedLimit', 'message' => 'The length of the WindowsPasswordName exceeds the upper limit.', 'http_code' => 403, 'description' => 'The specified WindowsPasswordName parameter length exceeds the upper limit.'],
['code' => 'WindowsPasswordName.Missed', 'message' => 'WindowsPasswordName must be specified when you create a Windows task.', 'http_code' => 400, 'description' => 'A value for the request parameter \'Command Type (WindowsPasswordName) \'was not provided.'],
['code' => 'Workbench.InternalFailure', 'message' => 'ECS workbench returns an internal failure. Please check password expiration policy and / or other issues.', 'http_code' => 400, 'description' => 'The ECS workbench API returned an internal error, with a high probability that the account password is incorrect. Please check whether the host account password has expired, and other possible circumstances.'],
['code' => 'Your payment method is invalid. Please contact our technical support team or submit a ticket.', 'message' => 'No payment method is specified for your account. Please contact your Customer Manager or open a ticket.', 'http_code' => 400, 'description' => 'A payment error occurred. Contact your customer manager or submit a ticket.'],
['code' => 'ZoneId.NotMatchWithCategory', 'message' => 'The number of ZoneId specified does not match with category.', 'http_code' => 400, 'description' => 'The number of zones is not supported for the database engine or the RDS edition of the RDS instance. Modify the zone settings.'],
['code' => 'ZoneId.NotMatchWithCategory', 'message' => 'The number of available zones does not match the database engine or instance edition. Please reset it.', 'http_code' => 400, 'description' => 'The number of zones does not match the database type or instance edition. Reconfigure the settings.'],
['code' => 'ZoneIdNotSupported', 'message' => 'The zone ID is not supported.', 'http_code' => 403, 'description' => 'The operation failed. The operation is not supported in the region.'],
['code' => 'ZONE_NOT_RESOURCE', 'message' => 'There are no resources available in this zone.', 'http_code' => 400, 'description' => 'No resources are available in the zone. Specify a different zone.'],
['code' => 'OperationDenied.SystemConcurrent', 'message' => 'Failure caused by Concurrent operations.', 'http_code' => 500, 'description' => 'The concurrent operation failed. Try again later.'],
['code' => 'RR029', 'message' => 'Your account has been flagged as abnormal and has been blocked by our risk control system. For more details, please contact customer service.', 'http_code' => 403, 'description' => 'Your account is abnormal and blocked by wind control. Please contact customer service for details.'],
['code' => 'InvalidRequest', 'message' => 'Invalid Request.', 'http_code' => 400, 'description' => 'Invalid Request'],
['code' => 'InvalidParameter.InstanceId', 'message' => 'The specified parameter InstanceId is invalid.', 'http_code' => 400, 'description' => 'The specified parameter instance ID is invalid.'],
['code' => 'InstanceHasLinkedServerInfo', 'message' => 'The instance has linked server info, please delete linked server info first.', 'http_code' => 400, 'description' => 'The current instance has a linked server. Please delete it before migrating to the Availability Zone.'],
['code' => 'ByokRoleArnNotFound', 'message' => 'The roleArn can not be null.', 'http_code' => 403, 'description' => 'The roleArn can not be null.'],
['code' => 'IncorrectDBSslStatus', 'message' => 'The link address has been used by SSL, modification and deletion are prohibited.', 'http_code' => 400, 'description' => 'The link address has been used by SSL, modification and deletion are prohibited.'],
['code' => 'InvalidParameter.InvalidCategory', 'message' => 'The disk category is not valid.', 'http_code' => 404, 'description' => 'Illegal disk type.'],
['code' => 'Account.SupabaseAdminRestricted', 'message' => 'This account is managed by Supabase and is restricted from direct modification. Please use the Supabase Console or API.', 'http_code' => 401, 'description' => 'This account is managed by the Supabase and cannot be modified directly. Use the RDS Supabase console or API to modify.'],
['code' => 'GtidToSkipError', 'message' => 'Gtid to skip is null or format is incorrect.', 'http_code' => 400, 'description' => 'Gtid to skip is null or format is incorrect.'],
['code' => 'InvalidReplicationChannel.NotFound', 'message' => 'Specified replication channel does not exist.', 'http_code' => 404, 'description' => 'Specified replication channel does not exist.'],
['code' => 'InvalidReplicationChannelName.Forbid', 'message' => 'Specified replication channel name is forbidden (reserved for internal use).', 'http_code' => 400, 'description' => 'Specified replication channel name is forbidden (reserved for internal use).'],
['code' => 'InvalidReplicationChannel.Duplicate', 'message' => 'Specified replication channel already exists.', 'http_code' => 400, 'description' => 'Specified replication channel already exists.'],
['code' => 'MissingRebuildParam', 'message' => 'Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword.', 'http_code' => 400, 'description' => 'Missing required parameters for rebuild operation: MasterHost, MasterPort, MasterUser, MasterPassword.'],
['code' => 'MissingReplicationParam', 'message' => 'Missing required parameters for replication operation: MasterHost, MasterPort, MasterUser, MasterPassword.', 'http_code' => 400, 'description' => 'Missing necessary replication-related parameters'],
['code' => 'MissingOperationParam', 'message' => 'Missing required parameter: Operation.', 'http_code' => 400, 'description' => 'Missing required parameter: Operation.'],
['code' => 'InvalidOperation.NotSupport', 'message' => 'Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild.', 'http_code' => 400, 'description' => 'Specified operation is not supported. Supported operations: Stop, Start, Restart, Rebuild.'],
['code' => 'InvalidMasterPort.Format', 'message' => 'Specified MasterPort format is not valid.', 'http_code' => 400, 'description' => 'Specified MasterPort format is not valid.'],
['code' => 'DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance', 'message' => 'Current instance is already attached to another duckdb instance, operation is conflict.', 'http_code' => 400, 'description' => 'The current instance is already associated with another DUCKDB instance, which conflicts with the current DUCKDB operation.'],
['code' => 'InvalidParam.NotSupportJumboFrame', 'message' => 'Not support jumbo frame.', 'http_code' => 400, 'description' => 'The current specification does not support jumbo frames.'],
['code' => 'InvalidParameter.ImageName', 'message' => 'The image name is null.', 'http_code' => 400, 'description' => 'Mirror name not passed in'],
['code' => 'InvalidParameter.DuplicateImageName', 'message' => 'The image name is duplicated.', 'http_code' => 400, 'description' => 'Duplicate Mirror Name'],
['code' => 'InvalidHostName.Malformed', 'message' => 'The specified parameter HostName is not valid.', 'http_code' => 400, 'description' => 'The specified host name is illegal'],
['code' => 'OperationDenied.RCDeploymentSetIdPrefixExists', 'message' => 'The specified parameter rcDeploymentSetIdPrefix already exists.', 'http_code' => 400, 'description' => 'User\'s custom deployment set prefix already exists'],
['code' => 'ClusterName.NotFound', 'message' => 'The specified user cluster name is not config.', 'http_code' => 400, 'description' => 'The cluster name parameter for the user is not configured'],
['code' => 'InvalidParameter.RCDeploymentSetIdPrefix', 'message' => 'The specified parameter rcDeploymentSetIdPrefix is invalid.', 'http_code' => 400, 'description' => 'The specified deployment set prefix is invalid'],
['code' => 'InvalidDeploymentSetId.NotFound', 'message' => 'The specified DeploymentSetId does not exist.', 'http_code' => 400, 'description' => 'The specified parameter DeploymentSetId does not exist'],
['code' => 'IncorrectFileExtension', 'message' => 'The file extension does not support, we only support extensions like bak, trn, diff, log.', 'http_code' => 403, 'description' => 'The file extension is not supported. Only file types with bak,trn,diff, and log suffixes are supported.'],
['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'Your account balance is less than 100 yuan. Please top up first.', 'http_code' => 400, 'description' => 'The cash balance in your account is less than 100 yuan. Please recharge first.'],
['code' => 'InvalidOperation.InstanceStatusNotSupport', 'message' => 'The instance status is not support modify mtu config.', 'http_code' => 400, 'description' => 'The instance status does not support modifying the MTU configuration.'],
['code' => 'InvalidRetentionDays.Malformed', 'message' => 'The specified RetentionDays is not valid.', 'http_code' => 400, 'description' => 'The specified retention days are invalid. Check whether the RetentionDays parameter values are correct.'],
['code' => 'InvalidOperation.Conflict', 'message' => 'ecs task is conflicted.', 'http_code' => 400, 'description' => 'The ECS task corresponding to the Custom instance conflicts. Please try again later.'],
['code' => 'InvalidStatus.ValueNotSupported', 'message' => 'The specified instance status is not supported for the operation.', 'http_code' => 400, 'description' => 'The status of the current instance does not support this operation.'],
['code' => 'InvalidDBNodes', 'message' => 'DBNodes is not valid.', 'http_code' => 400, 'description' => 'DBNodes is not valid.'],
['code' => 'Order.UserCannotBuyCloudCommodity', 'message' => 'Missing the "Group Cloud Adoption" product tag. Purchase is disabled. For internal group scenarios, we recommend purchasing Subscription products.', 'http_code' => 400, 'description' => 'Missing the "Group Cloud Adoption" product tag. Purchase is disabled. For internal group scenarios, we recommend purchasing Subscription products.'],
['code' => 'InvalidParameter.DiskIds', 'message' => 'The specified parameter DiskIds is invalid.', 'http_code' => 400, 'description' => 'The specified disk parameter is invalid'],
['code' => 'InvalidParameter.SnapshotIds', 'message' => 'The specified parameter SnapshotIds is invalid.', 'http_code' => 400, 'description' => 'The specified snapshot parameters are invalid'],
['code' => 'OperationDenied.ZoneIsDisabled', 'message' => 'The specified zone is disabled. You cannot create a vSwitch in a disabled zone.', 'http_code' => 400, 'description' => 'The current zone is disabled and you are not allowed to create a VSwitch.'],
['code' => 'UnNativeEcs.CanNotCreateByShareSwitch', 'message' => 'The Specified unNative ecs can not create by share switch.', 'http_code' => 400, 'description' => 'This non-dual NIC instance cannot be created through a shared switch'],
['code' => 'UnsupportedInstanceLevel', 'message' => 'analytics read ins only support instance level myduckro.', 'http_code' => 403, 'description' => 'You need an analytic read-only instance, but the specification of the analytic read-only instance is not passed in.'],
['code' => 'InvalidDisk.SystemDiskSize', 'message' => 'The specified SystemDiskSize beyond the permitted range.', 'http_code' => 400, 'description' => 'The system disk size exceeds the maximum allowable value.'],
['code' => 'InvalidRcuParam', 'message' => 'Invalid RCU parameters for database instance.', 'http_code' => 400, 'description' => 'Invalid RCU parameters for database instance.'],
['code' => 'InvalidPitrSetting', 'message' => 'Log backup is disabled. Enable PITR requires log backup to be enabled.', 'http_code' => 400, 'description' => 'Log backup is disabled. If you enable any-point-in-time recovery, log backup must be enabled.'],
['code' => 'InvalidBackupInterval.Unsupported', 'message' => 'BackupInterval can be configured only when Category is set to Standard. The current instance is set to Flash. Please set Category to Standard.', 'http_code' => 400, 'description' => 'The backup in seconds (Category = Flash) is enabled for the current instance. BackupInterval is supported only when the Category value is Standard. Please set the Category value to Standard, then configure the BackupInterval parameter.'],
['code' => 'InvalidLocalLogRetentionHours.Malformed', 'message' => 'Parameter \'LocalLogRetentionHours\' is invalid.', 'http_code' => 400, 'description' => 'Illegal LocalLogRetentionHours parameter setting.'],
['code' => 'InvalidLogBackupLocalRetentionNumber.Malformed', 'message' => 'Parameter \'LogBackupLocalRetentionNumber\' is invalid.', 'http_code' => 400, 'description' => 'Parameter \'LogBackupLocalRetentionNumber\' is invalid.'],
['code' => 'InvalidIncrementBackupInterval.Malformed', 'message' => 'Parameter \'IncBackupInterval\' is invalid.', 'http_code' => 400, 'description' => 'The IncBackupInterval parameter value is invalid.'],
['code' => 'InvalidLocalLogRetentionSpace.Malformed', 'message' => 'Parameter \'LocalLogRetentionSpace\' is invalid.', 'http_code' => 400, 'description' => 'Parameter \'LocalLogRetentionSpace\' is invalid.'],
['code' => 'CommittedServerlessUsingElasticResource', 'message' => 'Instance is using elastic resources, can not modify to provision.', 'http_code' => 400, 'description' => 'The instance is using elastic resources and cannot be modified to a fixed specification.'],
['code' => 'BlueGreenDeployment.DeleteNotAllowedInDeleting', 'message' => 'Blue-green deployment is already being deleted, duplicate deletion is not allowed.', 'http_code' => 400, 'description' => 'Blue-green deployment is already being deleted, duplicate deletion is not allowed.'],
['code' => 'BlueGreenDeployment.DeleteNotAllowedInCreating', 'message' => 'Blue-green deployment is being created, deletion is not allowed.', 'http_code' => 400, 'description' => 'Blue-green deployment is being created, deletion is not allowed.'],
['code' => 'InvalidClientToken.ValueNotSupported', 'message' => 'The ClientToken provided is invalid.', 'http_code' => 400, 'description' => 'The specified ClientToken is illegal.'],
['code' => 'UnsupportedReduceDiskSize.BinlogSpeedTooFast', 'message' => 'Binlog generate speed is too fast for disk shrink operation.', 'http_code' => 403, 'description' => 'Binlog generate speed is too fast for disk shrink operation.'],
['code' => 'InvalidParameter.StatusNotSupport', 'message' => 'Using tags combined with status as query conditions is not supported.', 'http_code' => 400, 'description' => 'Incoming status is not supported when querying by label'],
['code' => 'InvalidBackupInterval.Malformed', 'message' => 'Parameter \'BackupInterval\' ins invalid.', 'http_code' => 400, 'description' => 'Parameter \'BackupInterval\' ins invalid.'],
['code' => 'InvalidParameter.DeploymentSetIds', 'message' => 'The specified parameter DeploymentSetIds is invalid.', 'http_code' => 400, 'description' => 'Invalid deployment set parameters specified'],
['code' => 'InvalidTargetEntity.Malformed', 'message' => 'the specified target entity is not found.', 'http_code' => 400, 'description' => 'The queried entity does not exist'],
['code' => 'InvalidDeploymentSetId.NotFound', 'message' => 'The specified deployment set does not exist.', 'http_code' => 400, 'description' => 'Input deployment set does not exist'],
['code' => 'Throttling.ConcurrentLimit', 'message' => 'Request was denied due to request throttling.', 'http_code' => 400, 'description' => 'The request was denied due to throttling.'],
['code' => 'IncorrectStatus.VpcPeer', 'message' => 'The specified resource of VpcPeer status is invalid.', 'http_code' => 400, 'description' => 'The vpc peer-to-peer connection between the vpc instance to which the switch belongs and the resource account is currently not activated.'],
['code' => 'ResourceNotFound.VpcPeer', 'message' => 'The specified resource of VpcPeer is not found.', 'http_code' => 400, 'description' => 'The vpc instance to which the VSwitch belongs in the request parameter has not established a vpc peer-to-peer connection with the resource account.'],
['code' => 'InvalidMasterDBInstanceName.NotFound', 'message' => 'The master instance does not exist under the target account.', 'http_code' => 400, 'description' => 'The primary instance is not found under the target account.'],
['code' => 'AgentInstance.AlreadyBound', 'message' => 'The specified agent instance is already bound to another MO instance.', 'http_code' => 400, 'description' => 'The specified Agent instance is already bound to another MO instance.'],
['code' => 'InvalidDiskSize.TooSmall', 'message' => 'Specified new disk size is less than the original disk size.', 'http_code' => 400, 'description' => 'The new disk specified is smaller than the original disk.'],
['code' => 'InvalidCollationName.Format', 'message' => 'Specified collation name is not valid.', 'http_code' => 400, 'description' => 'The sorting rule format is incorrect. Only the mysql instance takes effect and must correspond to the character set.'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildDBInstance'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckCreateDdrDBInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxyPerformance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserBackupFile'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesByExpireTime'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedHostGroups'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceSecurityGroupRule'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceNetType'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReadOnlyDBInstance'],
['threshold' => '50', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfoForChannel'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlots'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrderForDeleteDBNodes'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceEngineVersion'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateMigrateTask'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckAccountNameAvailable'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCDisks'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPGHbaConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAllWhitelistTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCharacterSetName'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDTCSecurityIpHostsForSQLServer'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDasInstanceConfig'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMigrateTasks'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyParameterLog'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceEndpoints'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoveryDBInstance'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDBProxyEndpointAddress'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMonitor'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableCrossRegion'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLLogFiles'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpgradeMajorVersionTasks'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceProxyConfiguration'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockAccount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeQuickSaleConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLLogReportList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceEndpointAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBMiniEngineVersions'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossBackupMetaList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceEncryptionKey'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSupportOnlineResizeDisk'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBNode'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckInstanceExist'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBNodes'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTempDBInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLCollectorPolicy'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachRCDisk'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackups'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePGHbaConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountCheckPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyReadonlyInstanceDelayReplicationTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeOperatorPermission'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSpec'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeADInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateSecurityIPMode'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLocalAvailableRecoveryTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyEndpoint'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGadInstanceMember'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreCheckCreateOrderForDeleteDBNodes'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHADiagnoseConfig'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GrantOperatorPermission'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTaskInfo'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHADiagnoseConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableRecoveryTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIpHostname'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceKeywords'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSecurityGroupRule'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceSecurityGroupRule'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionLogBackupFiles'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeAccountPrivilege'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyDatabaseBetweenInstances'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachGadInstanceMember'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachWhitelistTemplateToInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateDBInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSecret'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGadInstances'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceLinkedWhitelistTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateMigrationTargetInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBNodes'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AllocateReadWriteSplittingConnection'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedHosts'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGadInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceAutoUpgradeMinorVersion'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyEndpointAddress'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserBackupFiles'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVSwitches'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHASwitchConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDbProxyInstanceSsl'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDdrInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudMigrationTask'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxyInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyReadWriteSplittingConnection'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMaintainTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCClusterNodes'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionBackups'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DestroyDBInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyResourceGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceCrossBackupPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActionEventPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBNodes'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceUsage'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustinsResourceInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurgeDBInstanceLog'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceReplication'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableZones'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseReadWriteSplittingConnection'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeErrorLogs'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceHAConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockAccount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceMajorVersion'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesAsCsv'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBProxyEndpointAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePrice'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParameterGroup'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMetaList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceMetrics'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesByPerformance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDelayedReplicationTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatabase'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCDisk'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEventInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWhitelistTemplate'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxy'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceIPArrayList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModifyPGHbaConfigLog'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMigrateTask'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhitelistTemplateLinkedInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceMajorVersionPrecheck'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateServiceLinkedRole'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatabases'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePostgresExtensions'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMonitor'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDetachedBackups'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceDetail'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceHAConfig'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceEndpointAddress'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOssDownloads'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameter'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBProxyInstanceKernelVersion'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachRCDisk'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMarketingActivity'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartDBInstance'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResourceDetails'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityGroupConfiguration'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformDBInstancePayType'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkExpireTime'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteReplicationLink'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeReplicationLinkLogs'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstancePayType'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateYouhuiForOrder'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBDescription'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckDBNameAvailable'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePromoteActivity'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceCrossBackupPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRCSnapshot'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecurityGroupConfiguration'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagsToResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBinlogFiles'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeReadDBInstanceDelay'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePostgresExtensions'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostGroupElasticStrategyParameters'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTasks'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateConnectionToOtherZone'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReplicationLink'],
['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstanceAttribute'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceLinkedRole'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKmsAssociateResources'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCClusterNodes'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableMetrics'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAutoRenewalAttribute'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegionInfos'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAvailableClasses'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRdsResourceSettings'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceEndpointAddress'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustinsResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatabase'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollationTimeZones'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameterGroup'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryNotify'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAutoRenewalAttribute'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySQLCollectorRetention'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBProxyEndpoint'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceVpc'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyADInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGADInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EvaluateLocalExtendDisk'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDbProxyInstanceSsl'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudMigrationPrecheckResult'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTagsFromResource'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClasses'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSQLLogRecords'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyHASwitchConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreTable'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOnlineDatabaseTask'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAnalyticdbByPrimaryDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReceiveDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloneParameterGroup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCClusterConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDBInstanceTopology'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatabaseConfig'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudMigrationPrecheckTask'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWhitelistTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceTDE'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancePerformance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeActionEventPolicy'],
['threshold' => '6000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBInstances'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupDatabase'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecommendByCode'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClassDetails'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRCSnapshots'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBProxy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescibeImportsFromDatabase'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceConnectivity'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstanceConnection'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyDatabase'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceTDE'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSSL'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSlot'],
['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreDdrTable'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCurrentModifyOrder'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpgradeMajorVersionPrecheckTask'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSecrets'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDBInstanceEndpoint'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudMigrationResult'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConfirmNotify'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CalculateDBInstanceWeight'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRCSnapshot'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePostgresExtensions'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachWhitelistTemplateToInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceNetworkType'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportUserBackupFile'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDTCSecurityIpHostsForSQLServer'],
['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogs'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceEndpoint'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDescription'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParameterGroup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceEndpoint'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteADSetting'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMigrateTaskById'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSQLCollectorRetention'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountSecurityPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserBackupFile'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCrossRegionBackupDBInstance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildReplicationLink'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeDBInstanceKernelVersion'],
['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceSecurityGroupRule'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMetrics'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogBackupFiles'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackupFile'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstancesForClone'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachRCInstances'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDBInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceByTags'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDBInstanceForRebuild'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateEipAddressWithRCInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceSSL'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEvents'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEvents'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupTasks'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecret'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEventsStat'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceReplicationSwitch'],
['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCollationTimeZone'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceDeletionProtection'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHostWebShell'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePostgresExtensions'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchDBInstanceHA'],
],
'product' => ['code' => 'mysql', 'title' => 'Rds'],
],
'ram' => [
'productCode' => 'RDS',
'productName' => 'ApsaraDB RDS',
'ramCodes' => ['rds'],
'ramLevel' => 'SERVICE',
'ramConditions' => [
[
'name' => 'rds:ResourceTag',
'schema' => ['type' => 'STRING', 'description' => 'Resource tag, it is used in combination with tag key, rds:ResourceTag/<tag-key>. Example: Assuming the tag is team:dev, the condition key and its value are \\\\\\\\\\\\"rds:ResourceTag/team\\\\\\\\\\\\": \\\\\\\\\\\\"dev\\\\\\\\\\\\"'],
],
[
'name' => 'rds:EnableEventLog',
'schema' => [
'type' => 'String',
'description' => 'Whether to enable the event history feature',
'enums' => ['true', 'false'],
],
],
[
'name' => 'rds:DBInstanceStorage',
'schema' => ['type' => 'Numeric', 'description' => 'Disk Size'],
],
[
'name' => 'rds:Engine',
'schema' => [
'type' => 'String',
'description' => 'Database Engine',
'enums' => ['MySQL', 'SQLServer', 'PostgreSQL'],
],
],
[
'name' => 'rds:InstanceNetworkType',
'schema' => [
'type' => 'String',
'description' => 'The network type of the instance.',
'enums' => ['VPC'],
],
],
[
'name' => 'rds:LogBackupEnabled',
'schema' => [
'type' => 'String',
'description' => 'Whether to enable the cross-region log backup feature on the instance.',
'enums' => ['0', '1'],
],
],
[
'name' => 'rds:TDEStatus',
'schema' => [
'type' => 'String',
'description' => 'TDE status.',
'enums' => ['Enabled', 'Disabled'],
],
],
[
'name' => 'rds:DBProxyConnectStringNetType',
'schema' => [
'type' => 'String',
'description' => 'The network type of the proxy endpoint.',
'enums' => ['Public', 'VPC', 'Classic'],
],
],
[
'name' => 'rds:BackupLog',
'schema' => [
'type' => 'String',
'description' => 'Whether to enable the log backup feature.',
'enums' => ['Enable', 'Disabled'],
],
],
[
'name' => 'rds:DiskEncryptionRequired',
'schema' => [
'type' => 'String',
'description' => 'Whether the disk is encrypted.',
'enums' => ['true', 'false'],
],
],
[
'name' => 'rds:DbProxySslEnabled',
'schema' => [
'type' => 'String',
'description' => 'The SSL configuration setting that you want to apply on the instance.',
'enums' => ['0', '1', '2'],
],
],
[
'name' => 'rds:EngineVersion',
'schema' => [
'type' => 'String',
'description' => 'Engine Version',
'enums' => ['5.6', '5.7', '8.0'],
],
],
[
'name' => 'rds:DBInstanceClass',
'schema' => ['type' => 'String', 'description' => 'Instance specifications'],
],
[
'name' => 'rds:BackupEnabled',
'schema' => [
'type' => 'String',
'description' => 'Whether to enable the cross-region backup feature on the instance.',
'enums' => ['0', '1'],
],
],
[
'name' => 'rds:EnableBackupLog',
'schema' => [
'type' => 'String',
'description' => 'Whether to enable the log backup feature',
'enums' => ['0', '1'],
],
],
[
'name' => 'rds:SSLEnabled',
'schema' => [
'type' => 'String',
'description' => 'Whether SSL is enabled',
'enums' => ['0', '1'],
],
],
[
'name' => 'rds:TLSVersion',
'schema' => ['type' => 'String', 'description' => 'TLS version,example: TLSv1,TLSv1.1,TLSv1.2.'],
],
],
'ramActions' => [],
'resourceTypes' => [],
],
];